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.

Bu Sun Kim

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

[diff] [blame]

157

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

Bu Sun Kim

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

[diff] [blame]

158

"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

159

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

160

# Default is false.

161

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

162

"A String",

Dan O'Meara

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

[diff] [blame]

163

],

Bu Sun Kim

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

[diff] [blame]

164

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

165

"A String",

166

],

167

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

168

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

169

"A String",

170

],

171

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

172

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

173

"A String",

174

],

175

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

176

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

177

"A String",

178

],

179

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

180

},

181

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

182

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

183

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

184

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

185

# The value must be between 200 and 599 inclusive.

186

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

187

# The value must be between 0.0 and 100.0 inclusive.

188

},

189

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

190

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

191

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

192

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

193

},

194

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

195

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

196

},

197

},

Bu Sun Kim

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

[diff] [blame]

198

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

199

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

200

},

201

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

202

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

203

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

204

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

205

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

206

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

207

},

Bu Sun Kim

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

[diff] [blame]

208

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

209

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

210

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

211

# -

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

"A String",

Dan O'Meara

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

[diff] [blame]

220

],

221

},

Bu Sun Kim

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

[diff] [blame]

222

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

223

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

224

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

225

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

226

},

227

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

Bu Sun Kim

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

[diff] [blame]

228

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

Bu Sun Kim

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

[diff] [blame]

229

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

230

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

231

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

232

# The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

233

},

Bu Sun Kim

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

[diff] [blame]

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

# The default value is false.

246

},

247

],

248

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

249

"A String",

250

],

251

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

252

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

253

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

254

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

255

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

256

# The default value is false.

257

},

258

],

259

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

264

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

265

# The value must be between 0 and 1000

Dan O'Meara

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

[diff] [blame]

266

},

267

],

Dan O'Meara

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

[diff] [blame]

268

},

Bu Sun Kim

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

[diff] [blame]

269

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

270

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

271

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

272

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

273

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

274

# The value must be between 1 and 255 characters.

275

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

276

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

277

# The default is set to false.

278

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

279

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

280

# The value must be between 1 and 1024 characters.

281

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

282

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

283

# The value must be between 1 and 1024 characters.

284

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

285

# Supported values are:

286

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

287

# - FOUND, which corresponds to 302.

288

# - SEE_OTHER which corresponds to 303.

289

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

290

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

291

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

292

# The default is set to false.

293

},

294

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

295

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

296

#

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

# The default value is false.

306

},

307

],

308

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

309

"A String",

310

],

311

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

312

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

313

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

314

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

315

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

316

# The default value is false.

317

},

318

],

319

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

324

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

325

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

326

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

327

"A String",

328

],

329

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

330

},

331

],

332

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

333

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

334

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

335

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

336

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

337

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

338

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

339

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

Bu Sun Kim

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

[diff] [blame]

340

"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

341

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

342

# Default is false.

343

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

344

"A String",

345

],

346

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

347

"A String",

348

],

349

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

350

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

351

"A String",

352

],

353

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

354

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

355

"A String",

356

],

357

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

358

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

359

"A String",

360

],

361

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

362

},

363

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

364

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

365

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

366

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

367

# The value must be between 200 and 599 inclusive.

368

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

369

# The value must be between 0.0 and 100.0 inclusive.

370

},

371

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

372

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

373

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

374

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

375

},

376

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

377

# The value must be between 0.0 and 100.0 inclusive.

378

},

379

},

380

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

381

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

382

},

383

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

384

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

385

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

386

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

387

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

388

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

389

},

390

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

391

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

392

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

393

# -

394

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

395

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

396

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

397

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

398

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

399

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

400

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

405

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

406

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

407

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

408

},

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

Bu Sun Kim

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

[diff] [blame]

411

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

412

# The value must be between 1 and 255 characters.

413

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

414

# The value must be between 1 and 1024 characters.

415

},

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

# The default value is false.

428

},

429

],

430

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

431

"A String",

432

],

433

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

434

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

435

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

436

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

437

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

438

# The default value is false.

439

},

440

],

441

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

446

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

447

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

452

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

453

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

454

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

455

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

456

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

457

# - compute.backendBuckets.use

458

# - compute.backendServices.use

459

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

460

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

461

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

462

# The value must be between 1 and 255 characters.

463

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

464

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

465

# The default is set to false.

466

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

467

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

468

# The value must be between 1 and 1024 characters.

469

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

470

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

471

# The value must be between 1 and 1024 characters.

472

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

473

# Supported values are:

474

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

475

# - FOUND, which corresponds to 302.

476

# - SEE_OTHER which corresponds to 303.

477

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

478

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

479

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

480

# The default is set to false.

481

},

482

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

483

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

484

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

485

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

486

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

487

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

488

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

489

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

490

# The default value is false.

491

},

492

],

493

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

494

"A String",

495

],

496

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

497

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

498

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

499

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

500

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

501

# The default value is false.

502

},

503

],

504

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

509

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

510

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

511

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

512

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

513

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

514

"A String",

515

],

516

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

517

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

518

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

Bu Sun Kim

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

[diff] [blame]

519

"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

520

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

521

# Default is false.

522

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

523

"A String",

524

],

525

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

526

"A String",

527

],

528

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

529

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

530

"A String",

531

],

532

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

533

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

534

"A String",

535

],

536

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

537

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

538

"A String",

539

],

540

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

541

},

542

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

543

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

544

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

545

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

546

# The value must be between 200 and 599 inclusive.

547

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

548

# The value must be between 0.0 and 100.0 inclusive.

549

},

550

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

551

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

552

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

553

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

554

},

555

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

556

# The value must be between 0.0 and 100.0 inclusive.

557

},

558

},

559

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

560

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

561

},

562

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

563

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

564

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

565

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

566

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

567

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

568

},

569

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

570

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

571

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

572

# -

573

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

574

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

575

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

576

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

577

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

578

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

579

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

584

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

585

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

586

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

587

},

588

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

Bu Sun Kim

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

[diff] [blame]

589

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

Bu Sun Kim

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

[diff] [blame]

590

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

591

# The value must be between 1 and 255 characters.

592

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

593

# The value must be between 1 and 1024 characters.

594

},

595

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

596

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

597

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

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

# The default value is false.

607

},

608

],

609

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

610

"A String",

611

],

612

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

613

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

614

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

615

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

616

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

617

# The default value is false.

618

},

619

],

620

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

625

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

626

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

631

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

632

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

633

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

634

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

635

# The value must be between 1 and 255 characters.

636

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

637

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

638

# The default is set to false.

639

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

640

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

641

# The value must be between 1 and 1024 characters.

642

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

643

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

644

# The value must be between 1 and 1024 characters.

645

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

646

# Supported values are:

647

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

648

# - FOUND, which corresponds to 302.

649

# - SEE_OTHER which corresponds to 303.

650

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

651

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

652

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

653

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

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

# The default value is false.

670

},

671

],

672

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

673

"A String",

674

],

675

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

676

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

677

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

678

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

679

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

680

# The default value is false.

681

},

682

],

683

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

689

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

690

# fullPathMatch must be between 1 and 1024 characters.

691

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

692

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

693

{ # matchRule criteria for request header matches.

694

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

695

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

696

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

697

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

698

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

699

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

700

# The default setting is false.

701

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

702

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

703

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

704

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

705

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

706

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

707

# - -3 will match.

708

# - 0 will not match.

709

# - 0.25 will not match.

710

# - -3someString will not match.

711

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

712

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

713

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

714

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

715

},

716

"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

717

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

718

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

719

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

720

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

721

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

722

},

723

],

724

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

725

# The default value is false.

726

# ignoreCase must not be used with regexMatch.

727

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

728

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

729

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

730

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

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

# value can have a maximum length of 1024 characters.

741

},

742

],

743

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

744

# Supported values are:

745

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

746

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

747

},

748

],

749

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

750

# The value must be between 1 and 1024 characters.

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

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

759

"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

760

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

761

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

762

},

763

],

764

"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

765

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

766

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

767

},

768

],

769

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

770

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

771

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

772

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

773

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

774

"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

775

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

776

# Default is false.

777

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

778

"A String",

779

],

780

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

781

"A String",

782

],

783

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

784

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

785

"A String",

786

],

787

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

788

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

789

"A String",

790

],

791

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

792

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

793

"A String",

794

],

795

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

796

},

797

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

798

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

799

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

800

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

801

# The value must be between 200 and 599 inclusive.

802

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

803

# The value must be between 0.0 and 100.0 inclusive.

804

},

805

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

806

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

807

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

808

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

809

},

810

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

811

# The value must be between 0.0 and 100.0 inclusive.

812

},

813

},

814

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

815

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

816

},

817

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

818

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

819

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

820

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

821

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

822

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

823

},

824

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

825

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

826

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

827

# -

828

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

829

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

830

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

831

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

832

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

833

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

834

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

839

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

840

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

841

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

842

},

843

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

Bu Sun Kim

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

[diff] [blame]

844

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

Bu Sun Kim

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

[diff] [blame]

845

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

846

# The value must be between 1 and 255 characters.

847

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

848

# The value must be between 1 and 1024 characters.

849

},

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

# The default value is false.

862

},

863

],

864

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

865

"A String",

866

],

867

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

868

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

869

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

870

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

871

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

872

# The default value is false.

873

},

874

],

875

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

880

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

881

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

886

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

887

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

888

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

889

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

890

# The value must be between 1 and 255 characters.

891

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

892

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

893

# The default is set to false.

894

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

895

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

896

# The value must be between 1 and 1024 characters.

897

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

898

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

899

# The value must be between 1 and 1024 characters.

900

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

901

# Supported values are:

902

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

903

# - FOUND, which corresponds to 302.

904

# - SEE_OTHER which corresponds to 303.

905

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

906

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

907

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

908

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

915

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

916

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

917

{ # Message for the expected URL mappings.

918

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

919

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

920

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

921

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

922

},

923

],

924

},

Dan O'Meara

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

[diff] [blame]

925

],

Bu Sun Kim

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

[diff] [blame]

926

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

927

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

928

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

929

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

Dan O'Meara

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

[diff] [blame]

930

{

Bu Sun Kim

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

[diff] [blame]

931

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

932

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

933

},

934

],

Bu Sun Kim

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

[diff] [blame]

935

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

936

},

937

},

938

},

Bu Sun Kim

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

[diff] [blame]

939

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

940

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

941

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

942

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

943

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

944

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

945

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

Dan O'Meara

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

[diff] [blame]

946

{

Bu Sun Kim

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

[diff] [blame]

947

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

948

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

949

},

950

],

Bu Sun Kim

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

[diff] [blame]

951

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

952

},

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>

958

<pre>Retrieves the next page of results.

959

960

Args:

961

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

962

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

963

964

Returns:

Bu Sun Kim

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

[diff] [blame]

965

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]

966

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]

971

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

Craig Citro

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

[diff] [blame]

972

<pre>Deletes the specified UrlMap resource.

973

974

Args:

Jon Wayne Parrott

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

[diff] [blame]

975

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

Craig Citro

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

[diff] [blame]

976

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

Bu Sun Kim

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

[diff] [blame]

977

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.

978

979

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.

980

981

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]

982

983

Returns:

984

An object of the form:

985

Bu Sun Kim

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

[diff] [blame]

986

{ # Represents an Operation resource.

987

#

Dan O'Meara

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

[diff] [blame]

988

# Google Compute Engine has three Operation resources:

989

#

990

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

991

#

Bu Sun Kim

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

[diff] [blame]

992

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

993

#

994

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

995

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

996

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

997

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

Bu Sun Kim

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

[diff] [blame]

998

#

Dan O'Meara

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

[diff] [blame]

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

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

Craig Citro

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

[diff] [blame]

1006

{

Bu Sun Kim

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

[diff] [blame]

1007

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

1008

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

1009

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

Craig Citro

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

[diff] [blame]

1010

},

1011

],

1012

},

Bu Sun Kim

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

[diff] [blame]

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

{

1031

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

1032

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

1033

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

1034

{

1035

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

1036

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

1037

},

1038

],

1039

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

1040

},

1041

],

1042

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

1048

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

1049

1050

Args:

Jon Wayne Parrott

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

[diff] [blame]

1051

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

Craig Citro

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

[diff] [blame]

1052

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

1053

1054

Returns:

1055

An object of the form:

1056

Dan O'Meara

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

[diff] [blame]

1057

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1058

#

1059

# Google Compute Engine has two URL Map resources:

1060

#

1061

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

1062

#

1063

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

1064

#

1065

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

1066

#

1067

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

1068

#

1069

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

1070

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

1071

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

1072

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

1073

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

Bu Sun Kim

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

[diff] [blame]

1074

"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

1075

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

1076

# Default is false.

1077

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

1078

"A String",

Dan O'Meara

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

[diff] [blame]

1079

],

Bu Sun Kim

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

[diff] [blame]

1080

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

1081

"A String",

1082

],

1083

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

1084

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

1085

"A String",

1086

],

1087

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

1088

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

1089

"A String",

1090

],

1091

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

1092

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

1093

"A String",

1094

],

1095

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

1096

},

1097

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

1098

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

1099

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

1100

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

1101

# The value must be between 200 and 599 inclusive.

1102

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

1103

# The value must be between 0.0 and 100.0 inclusive.

1104

},

1105

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

1106

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

1107

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

1108

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

1109

},

1110

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

1111

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

1112

},

1113

},

Bu Sun Kim

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

[diff] [blame]

1114

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

1115

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

1116

},

1117

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

1118

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

1119

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

1120

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

1121

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

1122

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

1123

},

Bu Sun Kim

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

[diff] [blame]

1124

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

1125

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

1126

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

1127

# -

1128

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

1129

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

1130

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

1131

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

1132

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

1133

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

1134

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

1135

"A String",

Dan O'Meara

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

[diff] [blame]

1136

],

1137

},

Bu Sun Kim

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

[diff] [blame]

1138

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

1139

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

1140

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

1141

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

1142

},

1143

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

Bu Sun Kim

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

[diff] [blame]

1144

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

Bu Sun Kim

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

[diff] [blame]

1145

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

1146

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

1147

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

1148

# The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

1149

},

Bu Sun Kim

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

[diff] [blame]

1150

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

1151

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

1152

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

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

# The default value is false.

1162

},

1163

],

1164

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

1165

"A String",

1166

],

1167

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

1168

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

1169

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

1170

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

1171

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

1172

# The default value is false.

1173

},

1174

],

1175

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

1180

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

1181

# The value must be between 0 and 1000

Craig Citro

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

[diff] [blame]

1182

},

1183

],

Bu Sun Kim

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

[diff] [blame]

1184

},

1185

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

1186

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

1187

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

1188

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

1189

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

1190

# The value must be between 1 and 255 characters.

1191

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

1192

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

1193

# The default is set to false.

1194

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

1195

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

1196

# The value must be between 1 and 1024 characters.

1197

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

1198

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

1199

# The value must be between 1 and 1024 characters.

1200

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

1201

# Supported values are:

1202

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

1203

# - FOUND, which corresponds to 302.

1204

# - SEE_OTHER which corresponds to 303.

1205

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

1206

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

1207

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

1208

# The default is set to false.

1209

},

1210

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

1211

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

1212

#

1213

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

1214

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

1215

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

1216

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

1217

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

1218

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

1219

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

1220

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

1221

# The default value is false.

1222

},

1223

],

1224

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

1225

"A String",

1226

],

1227

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

1228

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

1229

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

1230

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

1231

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

1232

# The default value is false.

1233

},

1234

],

1235

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

1240

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

1241

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

1242

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

1243

"A String",

1244

],

1245

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

1246

},

1247

],

1248

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

1249

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

1250

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

1251

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

1252

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

1253

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

1254

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

1255

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

Bu Sun Kim

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

[diff] [blame]

1256

"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

1257

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

1258

# Default is false.

1259

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

1260

"A String",

1261

],

1262

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

1263

"A String",

1264

],

1265

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

1266

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

1267

"A String",

1268

],

1269

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

1270

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

1271

"A String",

1272

],

1273

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

1274

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

1275

"A String",

1276

],

1277

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

1278

},

1279

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

1280

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

1281

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

1282

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

1283

# The value must be between 200 and 599 inclusive.

1284

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

1285

# The value must be between 0.0 and 100.0 inclusive.

1286

},

1287

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

1288

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

1289

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

1290

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

1291

},

1292

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

1293

# The value must be between 0.0 and 100.0 inclusive.

1294

},

1295

},

1296

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

1297

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

1298

},

1299

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

1300

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

1301

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

1302

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

1303

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

1304

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

1305

},

1306

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

1307

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

1308

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

1309

# -

1310

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

1311

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

1312

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

1313

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

1314

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

1315

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

1316

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

1321

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

1322

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

1323

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

1324

},

1325

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

Bu Sun Kim

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

[diff] [blame]

1326

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

Bu Sun Kim

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

[diff] [blame]

1327

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

1328

# The value must be between 1 and 255 characters.

1329

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

1330

# The value must be between 1 and 1024 characters.

1331

},

1332

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

1333

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

1334

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

1335

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

1336

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

1337

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

1338

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

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

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

1347

"A String",

1348

],

1349

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

1350

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

1351

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

1352

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

1353

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

1354

# The default value is false.

1355

},

1356

],

1357

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

1362

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

1363

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

1368

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

1369

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

1370

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

1371

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

1372

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

1373

# - compute.backendBuckets.use

1374

# - compute.backendServices.use

1375

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

1376

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

1377

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

1378

# The value must be between 1 and 255 characters.

1379

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

1380

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

1381

# The default is set to false.

1382

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

1383

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

1384

# The value must be between 1 and 1024 characters.

1385

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

1386

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

1387

# The value must be between 1 and 1024 characters.

1388

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

1389

# Supported values are:

1390

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

1391

# - FOUND, which corresponds to 302.

1392

# - SEE_OTHER which corresponds to 303.

1393

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

1394

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

1395

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

1396

# The default is set to false.

1397

},

1398

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

1399

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

1400

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

1401

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

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

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

1410

"A String",

1411

],

1412

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1413

{ # Specification determining how headers are added to requests or responses.

1414

"headerName": "A String", # The name of the header.

1415

"headerValue": "A String", # The value of the header to add.

1416

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1417

# The default value is false.

1418

},

1419

],

1420

"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.

1425

"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.

1426

# 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.

1427

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1428

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1429

"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.

1430

"A String",

1431

],

1432

"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.

1433

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1434

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1435

"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

1436

"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.

1437

# Default is false.

1438

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1439

"A String",

1440

],

1441

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1442

"A String",

1443

],

1444

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1445

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1446

"A String",

1447

],

1448

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1449

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1450

"A String",

1451

],

1452

"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.

1453

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1454

"A String",

1455

],

1456

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1457

},

1458

"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.

1459

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1460

"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.

1461

"httpStatus": 42, # The HTTP status code used to abort the request.

1462

# The value must be between 200 and 599 inclusive.

1463

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1464

# The value must be between 0.0 and 100.0 inclusive.

1465

},

1466

"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.

1467

"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.

1468

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1469

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1470

},

1471

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1472

# The value must be between 0.0 and 100.0 inclusive.

1473

},

1474

},

1475

"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.

1476

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1477

},

1478

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1479

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1480

"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.

1481

# 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.

1482

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1483

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1484

},

1485

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1486

# - 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.

1487

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1488

# -

1489

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1490

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1491

# - 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.

1492

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1493

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1494

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1495

# - 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.

1500

# If not specified, will use the largest timeout among all backend services associated with the route.

1501

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1502

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1503

},

1504

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1505

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1506

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1507

# The value must be between 1 and 255 characters.

1508

"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.

1509

# The value must be between 1 and 1024 characters.

1510

},

1511

"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.

1512

# 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.

1513

{ # 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

1514

"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.

1515

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

1516

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1517

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1518

{ # Specification determining how headers are added to requests or responses.

1519

"headerName": "A String", # The name of the header.

1520

"headerValue": "A String", # The value of the header to add.

1521

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1522

# The default value is false.

1523

},

1524

],

1525

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1526

"A String",

1527

],

1528

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1529

{ # Specification determining how headers are added to requests or responses.

1530

"headerName": "A String", # The name of the header.

1531

"headerValue": "A String", # The value of the header to add.

1532

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1533

# The default value is false.

1534

},

1535

],

1536

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

1541

# 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.

1542

# 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.

1547

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1548

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1549

# If urlRedirect is specified, service or routeAction must not be set.

1550

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1551

# The value must be between 1 and 255 characters.

1552

"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.

1553

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1554

# The default is set to false.

1555

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1556

# 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.

1557

# The value must be between 1 and 1024 characters.

1558

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1559

# 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.

1560

# The value must be between 1 and 1024 characters.

1561

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1562

# Supported values are:

1563

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1564

# - FOUND, which corresponds to 302.

1565

# - SEE_OTHER which corresponds to 303.

1566

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1567

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1568

"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.

1569

# 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.

1574

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1575

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1576

"description": "A String", # The short description conveying the intent of this routeRule.

1577

# The description can have a maximum length of 1024 characters.

1578

"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.

1579

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

1580

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1581

{ # Specification determining how headers are added to requests or responses.

1582

"headerName": "A String", # The name of the header.

1583

"headerValue": "A String", # The value of the header to add.

1584

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1585

# The default value is false.

1586

},

1587

],

1588

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1589

"A String",

1590

],

1591

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1592

{ # Specification determining how headers are added to requests or responses.

1593

"headerName": "A String", # The name of the header.

1594

"headerValue": "A String", # The value of the header to add.

1595

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1596

# The default value is false.

1597

},

1598

],

1599

"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.

1605

"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.

1606

# fullPathMatch must be between 1 and 1024 characters.

1607

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1608

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1609

{ # matchRule criteria for request header matches.

1610

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1611

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1612

"headerName": "A String", # The name of the HTTP header to match.

1613

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1614

# For matching a request's method, use the headerName ":method".

1615

"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.

1616

# The default setting is false.

1617

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1618

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1619

"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.

1620

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1621

"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.

1622

# For example for a range [-5, 0]

1623

# - -3 will match.

1624

# - 0 will not match.

1625

# - 0.25 will not match.

1626

# - -3someString will not match.

1627

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1628

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1629

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1630

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1631

},

1632

"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

1633

# 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.

1634

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1635

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1636

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1637

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1638

},

1639

],

1640

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1641

# The default value is false.

1642

# ignoreCase must not be used with regexMatch.

1643

"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.

1644

# 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.

1645

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1646

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1647

{ # 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.

1648

# 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.

1649

# 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.

1650

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1651

# This list must not be empty and can have at the most 64 entries.

1652

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1653

"name": "A String", # Name of metadata label.

1654

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1655

"value": "A String", # The value of the label must match the specified value.

1656

# value can have a maximum length of 1024 characters.

1657

},

1658

],

1659

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1660

# Supported values are:

1661

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1662

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1663

},

1664

],

1665

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1666

# The value must be between 1 and 1024 characters.

1667

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1668

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1669

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1670

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1671

# Only one of presentMatch, exactMatch or regexMatch must be set.

1672

"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.

1673

"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.

1674

# Only one of presentMatch, exactMatch or regexMatch must be set.

1675

"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

1676

# Only one of presentMatch, exactMatch or regexMatch must be set.

1677

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1678

},

1679

],

1680

"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

1681

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1682

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1683

},

1684

],

1685

"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.

1686

# 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.

1687

# 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.

1688

"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.

1689

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1690

"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

1691

"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.

1692

# Default is false.

1693

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1694

"A String",

1695

],

1696

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1697

"A String",

1698

],

1699

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1700

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1701

"A String",

1702

],

1703

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1704

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1705

"A String",

1706

],

1707

"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.

1708

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1709

"A String",

1710

],

1711

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1712

},

1713

"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.

1714

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1715

"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.

1716

"httpStatus": 42, # The HTTP status code used to abort the request.

1717

# The value must be between 200 and 599 inclusive.

1718

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1719

# The value must be between 0.0 and 100.0 inclusive.

1720

},

1721

"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.

1722

"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.

1723

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1724

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1725

},

1726

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1727

# The value must be between 0.0 and 100.0 inclusive.

1728

},

1729

},

1730

"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.

1731

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1732

},

1733

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1734

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1735

"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.

1736

# 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.

1737

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1738

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1739

},

1740

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1741

# - 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.

1742

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1743

# -

1744

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1745

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1746

# - 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.

1747

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1748

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1749

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1750

# - 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.

1755

# If not specified, will use the largest timeout among all backend services associated with the route.

1756

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1757

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1758

},

1759

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1760

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1761

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1762

# The value must be between 1 and 255 characters.

1763

"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.

1764

# The value must be between 1 and 1024 characters.

1765

},

1766

"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.

1767

# 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.

1768

{ # 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

1769

"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.

1770

"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.

1771

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1772

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1773

{ # Specification determining how headers are added to requests or responses.

1774

"headerName": "A String", # The name of the header.

1775

"headerValue": "A String", # The value of the header to add.

1776

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1777

# The default value is false.

1778

},

1779

],

1780

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1781

"A String",

1782

],

1783

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1784

{ # Specification determining how headers are added to requests or responses.

1785

"headerName": "A String", # The name of the header.

1786

"headerValue": "A String", # The value of the header to add.

1787

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1788

# The default value is false.

1789

},

1790

],

1791

"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) .

1796

# 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.

1797

# 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.

1802

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1803

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1804

# If urlRedirect is specified, service or routeAction must not be set.

1805

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1806

# The value must be between 1 and 255 characters.

1807

"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.

1808

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1809

# The default is set to false.

1810

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1811

# 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.

1812

# The value must be between 1 and 1024 characters.

1813

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1814

# 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.

1815

# The value must be between 1 and 1024 characters.

1816

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1817

# Supported values are:

1818

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1819

# - FOUND, which corresponds to 302.

1820

# - SEE_OTHER which corresponds to 303.

1821

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1822

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1823

"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.

1824

# 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.

1831

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1832

"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.

1833

{ # Message for the expected URL mappings.

1834

"description": "A String", # Description of this test case.

1835

"host": "A String", # Host portion of the URL.

1836

"path": "A String", # Path portion of the URL.

1837

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

1838

},

1839

],

1840

}</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]

1844

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1845

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

1846

1847

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1848

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1849

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1850

The object takes the form of:

1851

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1852

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1853

#

1854

# Google Compute Engine has two URL Map resources:

1855

#

1856

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1857

#

1858

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1859

#

1860

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1861

#

1862

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1863

#

1864

# 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.

1865

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1866

"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.

1867

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1868

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1869

"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

1870

"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.

1871

# Default is false.

1872

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1873

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1874

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1875

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1876

"A String",

1877

],

1878

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1879

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1880

"A String",

1881

],

1882

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1883

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1884

"A String",

1885

],

1886

"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.

1887

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1888

"A String",

1889

],

1890

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1891

},

1892

"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.

1893

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1894

"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.

1895

"httpStatus": 42, # The HTTP status code used to abort the request.

1896

# The value must be between 200 and 599 inclusive.

1897

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1898

# The value must be between 0.0 and 100.0 inclusive.

1899

},

1900

"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.

1901

"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.

1902

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1903

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1904

},

1905

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1906

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1907

},

1908

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1909

"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.

1910

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1911

},

1912

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1913

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1914

"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.

1915

# 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.

1916

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1917

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

1918

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1919

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1920

# - 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.

1921

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1922

# -

1923

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1924

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1925

# - 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.

1926

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1927

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1928

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1929

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

1930

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1931

],

1932

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1933

"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.

1934

# If not specified, will use the largest timeout among all backend services associated with the route.

1935

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1936

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1937

},

1938

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1939

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1940

"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]

1941

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1942

"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.

1943

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1944

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1945

"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.

1946

# 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.

1947

{ # 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

1948

"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.

1949

"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.

1950

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1951

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1952

{ # Specification determining how headers are added to requests or responses.

1953

"headerName": "A String", # The name of the header.

1954

"headerValue": "A String", # The value of the header to add.

1955

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1956

# The default value is false.

1957

},

1958

],

1959

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1960

"A String",

1961

],

1962

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1963

{ # Specification determining how headers are added to requests or responses.

1964

"headerName": "A String", # The name of the header.

1965

"headerValue": "A String", # The value of the header to add.

1966

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1967

# The default value is false.

1968

},

1969

],

1970

"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) .

1975

# 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.

1976

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1977

},

1978

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1979

},

1980

"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.

1981

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1982

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1983

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1984

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1985

# The value must be between 1 and 255 characters.

1986

"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.

1987

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1988

# The default is set to false.

1989

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1990

# 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.

1991

# The value must be between 1 and 1024 characters.

1992

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1993

# 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.

1994

# The value must be between 1 and 1024 characters.

1995

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1996

# Supported values are:

1997

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1998

# - FOUND, which corresponds to 302.

1999

# - SEE_OTHER which corresponds to 303.

2000

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2001

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2002

"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.

2003

# The default is set to false.

2004

},

2005

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2006

"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.

2007

#

2008

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2009

"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.

2010

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2011

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2012

{ # Specification determining how headers are added to requests or responses.

2013

"headerName": "A String", # The name of the header.

2014

"headerValue": "A String", # The value of the header to add.

2015

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2016

# The default value is false.

2017

},

2018

],

2019

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2020

"A String",

2021

],

2022

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2023

{ # Specification determining how headers are added to requests or responses.

2024

"headerName": "A String", # The name of the header.

2025

"headerValue": "A String", # The value of the header to add.

2026

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2027

# The default value is false.

2028

},

2029

],

2030

"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.

2035

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2036

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2037

"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 ..

2038

"A String",

2039

],

2040

"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.

2041

},

2042

],

2043

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2044

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2045

"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.

2046

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2047

{ # 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.

2048

"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.

2049

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2050

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2051

"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

2052

"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.

2053

# Default is false.

2054

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2055

"A String",

2056

],

2057

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2058

"A String",

2059

],

2060

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2061

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2062

"A String",

2063

],

2064

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2065

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2066

"A String",

2067

],

2068

"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.

2069

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2070

"A String",

2071

],

2072

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2073

},

2074

"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.

2075

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2076

"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.

2077

"httpStatus": 42, # The HTTP status code used to abort the request.

2078

# The value must be between 200 and 599 inclusive.

2079

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2080

# The value must be between 0.0 and 100.0 inclusive.

2081

},

2082

"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.

2083

"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.

2084

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2085

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2086

},

2087

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2088

# The value must be between 0.0 and 100.0 inclusive.

2089

},

2090

},

2091

"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.

2092

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2093

},

2094

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2095

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2096

"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.

2097

# 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.

2098

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2099

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2100

},

2101

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2102

# - 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.

2103

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2104

# -

2105

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2106

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2107

# - 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.

2108

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2109

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2110

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2111

# - 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.

2116

# If not specified, will use the largest timeout among all backend services associated with the route.

2117

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2118

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2119

},

2120

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2121

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2122

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2123

# The value must be between 1 and 255 characters.

2124

"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.

2125

# The value must be between 1 and 1024 characters.

2126

},

2127

"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.

2128

# 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.

2129

{ # 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

2130

"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.

2131

"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.

2132

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2133

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2134

{ # Specification determining how headers are added to requests or responses.

2135

"headerName": "A String", # The name of the header.

2136

"headerValue": "A String", # The value of the header to add.

2137

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2138

# The default value is false.

2139

},

2140

],

2141

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2142

"A String",

2143

],

2144

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2145

{ # Specification determining how headers are added to requests or responses.

2146

"headerName": "A String", # The name of the header.

2147

"headerValue": "A String", # The value of the header to add.

2148

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2149

# The default value is false.

2150

},

2151

],

2152

"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) .

2157

# 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.

2158

# 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:

2163

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2164

# - compute/v1/projects/project/global/backendServices/backendService

2165

# - 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.

2166

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2167

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2168

# - compute.backendBuckets.use

2169

# - compute.backendServices.use

2170

"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.

2171

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2172

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2173

# The value must be between 1 and 255 characters.

2174

"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.

2175

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2176

# The default is set to false.

2177

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2178

# 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.

2179

# The value must be between 1 and 1024 characters.

2180

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2181

# 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.

2182

# The value must be between 1 and 1024 characters.

2183

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2184

# Supported values are:

2185

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2186

# - FOUND, which corresponds to 302.

2187

# - SEE_OTHER which corresponds to 303.

2188

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2189

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2190

"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.

2191

# The default is set to false.

2192

},

2193

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2194

"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.

2195

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2196

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2197

{ # Specification determining how headers are added to requests or responses.

2198

"headerName": "A String", # The name of the header.

2199

"headerValue": "A String", # The value of the header to add.

2200

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2201

# The default value is false.

2202

},

2203

],

2204

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2205

"A String",

2206

],

2207

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2208

{ # Specification determining how headers are added to requests or responses.

2209

"headerName": "A String", # The name of the header.

2210

"headerValue": "A String", # The value of the header to add.

2211

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2212

# The default value is false.

2213

},

2214

],

2215

"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.

2220

"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.

2221

# 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.

2222

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2223

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2224

"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.

2225

"A String",

2226

],

2227

"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.

2228

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2229

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2230

"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

2231

"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.

2232

# Default is false.

2233

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2234

"A String",

2235

],

2236

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2237

"A String",

2238

],

2239

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2240

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2241

"A String",

2242

],

2243

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2244

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2245

"A String",

2246

],

2247

"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.

2248

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2249

"A String",

2250

],

2251

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2252

},

2253

"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.

2254

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2255

"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.

2256

"httpStatus": 42, # The HTTP status code used to abort the request.

2257

# The value must be between 200 and 599 inclusive.

2258

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2259

# The value must be between 0.0 and 100.0 inclusive.

2260

},

2261

"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.

2262

"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.

2263

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2264

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2265

},

2266

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2267

# The value must be between 0.0 and 100.0 inclusive.

2268

},

2269

},

2270

"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.

2271

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2272

},

2273

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2274

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2275

"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.

2276

# 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.

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

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2281

# - 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.

2282

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2283

# -

2284

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2285

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2286

# - 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.

2287

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2288

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2289

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2290

# - 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.

2295

# If not specified, will use the largest timeout among all backend services associated with the route.

2296

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2297

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2298

},

2299

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2300

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2301

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2302

# The value must be between 1 and 255 characters.

2303

"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.

2304

# The value must be between 1 and 1024 characters.

2305

},

2306

"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.

2307

# 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.

2308

{ # 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

2309

"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.

2310

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

2311

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2312

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2313

{ # Specification determining how headers are added to requests or responses.

2314

"headerName": "A String", # The name of the header.

2315

"headerValue": "A String", # The value of the header to add.

2316

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2317

# The default value is false.

2318

},

2319

],

2320

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2321

"A String",

2322

],

2323

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2324

{ # Specification determining how headers are added to requests or responses.

2325

"headerName": "A String", # The name of the header.

2326

"headerValue": "A String", # The value of the header to add.

2327

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2328

# The default value is false.

2329

},

2330

],

2331

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

2336

# 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.

2337

# 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.

2342

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2343

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2344

# If urlRedirect is specified, service or routeAction must not be set.

2345

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2346

# The value must be between 1 and 255 characters.

2347

"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.

2348

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2349

# The default is set to false.

2350

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2351

# 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.

2352

# The value must be between 1 and 1024 characters.

2353

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2354

# 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.

2355

# The value must be between 1 and 1024 characters.

2356

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2357

# Supported values are:

2358

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2359

# - FOUND, which corresponds to 302.

2360

# - SEE_OTHER which corresponds to 303.

2361

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2362

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2363

"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.

2364

# 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.

2369

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2370

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2371

"description": "A String", # The short description conveying the intent of this routeRule.

2372

# The description can have a maximum length of 1024 characters.

2373

"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.

2374

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2375

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2376

{ # Specification determining how headers are added to requests or responses.

2377

"headerName": "A String", # The name of the header.

2378

"headerValue": "A String", # The value of the header to add.

2379

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2380

# The default value is false.

2381

},

2382

],

2383

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2384

"A String",

2385

],

2386

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2387

{ # Specification determining how headers are added to requests or responses.

2388

"headerName": "A String", # The name of the header.

2389

"headerValue": "A String", # The value of the header to add.

2390

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2391

# The default value is false.

2392

},

2393

],

2394

"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.

2400

"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.

2401

# fullPathMatch must be between 1 and 1024 characters.

2402

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2403

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2404

{ # matchRule criteria for request header matches.

2405

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2406

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2407

"headerName": "A String", # The name of the HTTP header to match.

2408

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2409

# For matching a request's method, use the headerName ":method".

2410

"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.

2411

# The default setting is false.

2412

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2413

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2414

"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.

2415

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2416

"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.

2417

# For example for a range [-5, 0]

2418

# - -3 will match.

2419

# - 0 will not match.

2420

# - 0.25 will not match.

2421

# - -3someString will not match.

2422

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2423

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2424

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2425

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2426

},

2427

"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

2428

# 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.

2429

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2430

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2431

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2432

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2433

},

2434

],

2435

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2436

# The default value is false.

2437

# ignoreCase must not be used with regexMatch.

2438

"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.

2439

# 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.

2440

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2441

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2442

{ # 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.

2443

# 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.

2444

# 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.

2445

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2446

# This list must not be empty and can have at the most 64 entries.

2447

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2448

"name": "A String", # Name of metadata label.

2449

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2450

"value": "A String", # The value of the label must match the specified value.

2451

# value can have a maximum length of 1024 characters.

2452

},

2453

],

2454

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2455

# Supported values are:

2456

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2457

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2458

},

2459

],

2460

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2461

# The value must be between 1 and 1024 characters.

2462

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2463

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2464

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2465

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2466

# Only one of presentMatch, exactMatch or regexMatch must be set.

2467

"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.

2468

"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.

2469

# Only one of presentMatch, exactMatch or regexMatch must be set.

2470

"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

2471

# Only one of presentMatch, exactMatch or regexMatch must be set.

2472

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2473

},

2474

],

2475

"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

2476

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2477

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2478

},

2479

],

2480

"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.

2481

# 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.

2482

# 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.

2483

"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.

2484

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2485

"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

2486

"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.

2487

# Default is false.

2488

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2489

"A String",

2490

],

2491

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2492

"A String",

2493

],

2494

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2495

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2496

"A String",

2497

],

2498

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2499

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2500

"A String",

2501

],

2502

"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.

2503

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2504

"A String",

2505

],

2506

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2507

},

2508

"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.

2509

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2510

"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.

2511

"httpStatus": 42, # The HTTP status code used to abort the request.

2512

# The value must be between 200 and 599 inclusive.

2513

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2514

# The value must be between 0.0 and 100.0 inclusive.

2515

},

2516

"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.

2517

"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.

2518

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2519

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2520

},

2521

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2522

# The value must be between 0.0 and 100.0 inclusive.

2523

},

2524

},

2525

"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.

2526

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2527

},

2528

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2529

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2530

"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.

2531

# 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.

2532

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2533

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2534

},

2535

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2536

# - 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.

2537

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2538

# -

2539

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2540

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2541

# - 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.

2542

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2543

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2544

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2545

# - 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.

2550

# If not specified, will use the largest timeout among all backend services associated with the route.

2551

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2552

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2553

},

2554

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2555

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2556

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2557

# The value must be between 1 and 255 characters.

2558

"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.

2559

# The value must be between 1 and 1024 characters.

2560

},

2561

"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.

2562

# 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.

2563

{ # 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

2564

"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.

2565

"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.

2566

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2567

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2568

{ # Specification determining how headers are added to requests or responses.

2569

"headerName": "A String", # The name of the header.

2570

"headerValue": "A String", # The value of the header to add.

2571

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2572

# The default value is false.

2573

},

2574

],

2575

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2576

"A String",

2577

],

2578

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2579

{ # Specification determining how headers are added to requests or responses.

2580

"headerName": "A String", # The name of the header.

2581

"headerValue": "A String", # The value of the header to add.

2582

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2583

# The default value is false.

2584

},

2585

],

2586

"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) .

2591

# 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.

2592

# 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.

2597

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2598

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2599

# If urlRedirect is specified, service or routeAction must not be set.

2600

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2601

# The value must be between 1 and 255 characters.

2602

"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.

2603

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2604

# The default is set to false.

2605

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2606

# 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.

2607

# The value must be between 1 and 1024 characters.

2608

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2609

# 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.

2610

# The value must be between 1 and 1024 characters.

2611

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2612

# Supported values are:

2613

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2614

# - FOUND, which corresponds to 302.

2615

# - SEE_OTHER which corresponds to 303.

2616

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2617

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2618

"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.

2619

# 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.

2626

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2627

"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.

2628

{ # Message for the expected URL mappings.

2629

"description": "A String", # Description of this test case.

2630

"host": "A String", # Host portion of the URL.

2631

"path": "A String", # Path portion of the URL.

2632

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

2633

},

2634

],

2635

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2636

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2637

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.

2638

2639

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.

2640

2641

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]

2642

2643

Returns:

2644

An object of the form:

2645

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2646

{ # Represents an Operation resource.

2647

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2648

# Google Compute Engine has three Operation resources:

2649

#

2650

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2651

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2652

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2653

#

2654

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2655

# - For global operations, use the `globalOperations` resource.

2656

# - For regional operations, use the `regionOperations` resource.

2657

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2658

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2659

# 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]

2660

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2661

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2662

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2663

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2664

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2665

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2666

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2667

"code": "A String", # [Output Only] The error type identifier for this error.

2668

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2669

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2670

},

2671

],

2672

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2673

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2674

"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.

2675

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2676

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2677

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2678

"name": "A String", # [Output Only] Name of the operation.

2679

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2680

"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.

2681

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2682

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2683

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2684

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2685

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2686

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2687

"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.

2688

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2689

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2690

{

2691

"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.

2692

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2693

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2694

{

2695

"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).

2696

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2697

},

2698

],

2699

"message": "A String", # [Output Only] A human-readable description of the warning code.

2700

},

2701

],

2702

"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]

2707

<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]

2708

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

2709

2710

Args:

2711

project: string, Project ID for this request. (required)

2712

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2713

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2714

The object takes the form of:

2715

2716

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2717

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

2718

"path": "A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2719

}

2720

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2721

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.

2722

2723

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.

2724

2725

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]

2726

2727

Returns:

2728

An object of the form:

2729

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2730

{ # Represents an Operation resource.

2731

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2732

# Google Compute Engine has three Operation resources:

2733

#

2734

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2735

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2736

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2737

#

2738

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2739

# - For global operations, use the `globalOperations` resource.

2740

# - For regional operations, use the `regionOperations` resource.

2741

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2742

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2743

# 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]

2744

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2745

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2746

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2747

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2748

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2749

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2750

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2751

"code": "A String", # [Output Only] The error type identifier for this error.

2752

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2753

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2754

},

2755

],

2756

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2757

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2758

"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.

2759

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2760

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2761

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2762

"name": "A String", # [Output Only] Name of the operation.

2763

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2764

"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.

2765

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2766

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2767

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2768

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2769

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2770

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2771

"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.

2772

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2773

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2774

{

2775

"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.

2776

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2777

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2778

{

2779

"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).

2780

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2781

},

2782

],

2783

"message": "A String", # [Output Only] A human-readable description of the warning code.

2784

},

2785

],

2786

"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]

2791

<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]

2792

<pre>Retrieves the list of UrlMap resources available to the specified project.

2793

2794

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2795

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2796

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]

2797

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2798

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]

2799

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2800

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]

2801

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2802

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) ```

2803

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`)

2804

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2805

2806

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.

2807

2808

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2809

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]

2810

2811

Returns:

2812

An object of the form:

2813

2814

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2815

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2816

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2817

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2818

#

2819

# Google Compute Engine has two URL Map resources:

2820

#

2821

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2822

#

2823

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2824

#

2825

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2826

#

2827

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2828

#

2829

# 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.

2830

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2831

"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.

2832

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2833

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2834

"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

2835

"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.

2836

# Default is false.

2837

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2838

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2839

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2840

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2841

"A String",

2842

],

2843

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2844

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2845

"A String",

2846

],

2847

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2848

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2849

"A String",

2850

],

2851

"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.

2852

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2853

"A String",

2854

],

2855

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2856

},

2857

"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.

2858

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2859

"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.

2860

"httpStatus": 42, # The HTTP status code used to abort the request.

2861

# The value must be between 200 and 599 inclusive.

2862

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2863

# The value must be between 0.0 and 100.0 inclusive.

2864

},

2865

"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.

2866

"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.

2867

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2868

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2869

},

2870

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2871

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2872

},

2873

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2874

"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.

2875

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2876

},

2877

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2878

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2879

"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.

2880

# 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.

2881

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2882

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

2883

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2884

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2885

# - 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.

2886

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2887

# -

2888

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2889

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2890

# - 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.

2891

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2892

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2893

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2894

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2895

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2896

],

2897

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2898

"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.

2899

# If not specified, will use the largest timeout among all backend services associated with the route.

2900

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2901

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2902

},

2903

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2904

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2905

"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]

2906

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2907

"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.

2908

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2909

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2910

"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.

2911

# 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.

2912

{ # 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

2913

"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.

2914

"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.

2915

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2916

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2917

{ # Specification determining how headers are added to requests or responses.

2918

"headerName": "A String", # The name of the header.

2919

"headerValue": "A String", # The value of the header to add.

2920

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2921

# The default value is false.

2922

},

2923

],

2924

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2925

"A String",

2926

],

2927

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2928

{ # Specification determining how headers are added to requests or responses.

2929

"headerName": "A String", # The name of the header.

2930

"headerValue": "A String", # The value of the header to add.

2931

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2932

# The default value is false.

2933

},

2934

],

2935

"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) .

2940

# 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.

2941

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2942

},

2943

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2944

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2945

"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.

2946

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2947

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2948

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2949

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2950

# The value must be between 1 and 255 characters.

2951

"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.

2952

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2953

# The default is set to false.

2954

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2955

# 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.

2956

# The value must be between 1 and 1024 characters.

2957

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2958

# 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.

2959

# The value must be between 1 and 1024 characters.

2960

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2961

# Supported values are:

2962

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2963

# - FOUND, which corresponds to 302.

2964

# - SEE_OTHER which corresponds to 303.

2965

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2966

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2967

"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.

2968

# The default is set to false.

2969

},

2970

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2971

"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.

2972

#

2973

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2974

"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.

2975

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2976

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2977

{ # Specification determining how headers are added to requests or responses.

2978

"headerName": "A String", # The name of the header.

2979

"headerValue": "A String", # The value of the header to add.

2980

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2981

# The default value is false.

2982

},

2983

],

2984

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2985

"A String",

2986

],

2987

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2988

{ # Specification determining how headers are added to requests or responses.

2989

"headerName": "A String", # The name of the header.

2990

"headerValue": "A String", # The value of the header to add.

2991

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2992

# The default value is false.

2993

},

2994

],

2995

"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.

3000

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3001

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3002

"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 ..

3003

"A String",

3004

],

3005

"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.

3006

},

3007

],

3008

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3009

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3010

"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.

3011

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3012

{ # 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.

3013

"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.

3014

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3015

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3016

"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

3017

"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.

3018

# Default is false.

3019

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3020

"A String",

3021

],

3022

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3023

"A String",

3024

],

3025

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3026

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3027

"A String",

3028

],

3029

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3030

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3031

"A String",

3032

],

3033

"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.

3034

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3035

"A String",

3036

],

3037

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3038

},

3039

"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.

3040

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3041

"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.

3042

"httpStatus": 42, # The HTTP status code used to abort the request.

3043

# The value must be between 200 and 599 inclusive.

3044

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3045

# The value must be between 0.0 and 100.0 inclusive.

3046

},

3047

"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.

3048

"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.

3049

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3050

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3051

},

3052

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3053

# The value must be between 0.0 and 100.0 inclusive.

3054

},

3055

},

3056

"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.

3057

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3058

},

3059

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3060

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3061

"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.

3062

# 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.

3063

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3064

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3065

},

3066

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3067

# - 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.

3068

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3069

# -

3070

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3071

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3072

# - 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.

3073

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3074

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3075

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3076

# - 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.

3081

# If not specified, will use the largest timeout among all backend services associated with the route.

3082

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3083

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3084

},

3085

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3086

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3087

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3088

# The value must be between 1 and 255 characters.

3089

"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.

3090

# The value must be between 1 and 1024 characters.

3091

},

3092

"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.

3093

# 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.

3094

{ # 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

3095

"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.

3096

"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.

3097

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3098

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3099

{ # Specification determining how headers are added to requests or responses.

3100

"headerName": "A String", # The name of the header.

3101

"headerValue": "A String", # The value of the header to add.

3102

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3103

# The default value is false.

3104

},

3105

],

3106

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3107

"A String",

3108

],

3109

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3110

{ # Specification determining how headers are added to requests or responses.

3111

"headerName": "A String", # The name of the header.

3112

"headerValue": "A String", # The value of the header to add.

3113

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3114

# The default value is false.

3115

},

3116

],

3117

"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) .

3122

# 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.

3123

# 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:

3128

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3129

# - compute/v1/projects/project/global/backendServices/backendService

3130

# - 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.

3131

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3132

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3133

# - compute.backendBuckets.use

3134

# - compute.backendServices.use

3135

"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.

3136

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3137

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3138

# The value must be between 1 and 255 characters.

3139

"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.

3140

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3141

# The default is set to false.

3142

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3143

# 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.

3144

# The value must be between 1 and 1024 characters.

3145

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3146

# 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.

3147

# The value must be between 1 and 1024 characters.

3148

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3149

# Supported values are:

3150

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3151

# - FOUND, which corresponds to 302.

3152

# - SEE_OTHER which corresponds to 303.

3153

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3154

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3155

"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.

3156

# The default is set to false.

3157

},

3158

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3159

"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.

3160

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3161

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3162

{ # Specification determining how headers are added to requests or responses.

3163

"headerName": "A String", # The name of the header.

3164

"headerValue": "A String", # The value of the header to add.

3165

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3166

# The default value is false.

3167

},

3168

],

3169

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3170

"A String",

3171

],

3172

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3173

{ # Specification determining how headers are added to requests or responses.

3174

"headerName": "A String", # The name of the header.

3175

"headerValue": "A String", # The value of the header to add.

3176

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3177

# The default value is false.

3178

},

3179

],

3180

"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.

3185

"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.

3186

# 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.

3187

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3188

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3189

"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.

3190

"A String",

3191

],

3192

"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.

3193

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3194

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3195

"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

3196

"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.

3197

# Default is false.

3198

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3199

"A String",

3200

],

3201

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3202

"A String",

3203

],

3204

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3205

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3206

"A String",

3207

],

3208

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3209

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3210

"A String",

3211

],

3212

"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.

3213

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3214

"A String",

3215

],

3216

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3217

},

3218

"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.

3219

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3220

"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.

3221

"httpStatus": 42, # The HTTP status code used to abort the request.

3222

# The value must be between 200 and 599 inclusive.

3223

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3224

# The value must be between 0.0 and 100.0 inclusive.

3225

},

3226

"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.

3227

"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.

3228

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3229

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3230

},

3231

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3232

# The value must be between 0.0 and 100.0 inclusive.

3233

},

3234

},

3235

"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.

3236

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3237

},

3238

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3239

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3240

"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.

3241

# 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.

3242

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3243

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3244

},

3245

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3246

# - 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.

3247

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3248

# -

3249

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3250

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3251

# - 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.

3252

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3253

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3254

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3255

# - 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.

3260

# If not specified, will use the largest timeout among all backend services associated with the route.

3261

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3262

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3263

},

3264

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3265

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3266

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3267

# The value must be between 1 and 255 characters.

3268

"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.

3269

# The value must be between 1 and 1024 characters.

3270

},

3271

"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.

3272

# 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.

3273

{ # 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

3274

"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.

3275

"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.

3276

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3277

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3278

{ # Specification determining how headers are added to requests or responses.

3279

"headerName": "A String", # The name of the header.

3280

"headerValue": "A String", # The value of the header to add.

3281

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3282

# The default value is false.

3283

},

3284

],

3285

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3286

"A String",

3287

],

3288

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3289

{ # Specification determining how headers are added to requests or responses.

3290

"headerName": "A String", # The name of the header.

3291

"headerValue": "A String", # The value of the header to add.

3292

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3293

# The default value is false.

3294

},

3295

],

3296

"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) .

3301

# 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.

3302

# 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.

3307

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3308

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3309

# If urlRedirect is specified, service or routeAction must not be set.

3310

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3311

# The value must be between 1 and 255 characters.

3312

"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.

3313

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3314

# The default is set to false.

3315

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3316

# 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.

3317

# The value must be between 1 and 1024 characters.

3318

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3319

# 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.

3320

# The value must be between 1 and 1024 characters.

3321

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3322

# Supported values are:

3323

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3324

# - FOUND, which corresponds to 302.

3325

# - SEE_OTHER which corresponds to 303.

3326

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3327

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3328

"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.

3329

# 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.

3334

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3335

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3336

"description": "A String", # The short description conveying the intent of this routeRule.

3337

# The description can have a maximum length of 1024 characters.

3338

"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.

3339

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3340

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3341

{ # Specification determining how headers are added to requests or responses.

3342

"headerName": "A String", # The name of the header.

3343

"headerValue": "A String", # The value of the header to add.

3344

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3345

# The default value is false.

3346

},

3347

],

3348

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3349

"A String",

3350

],

3351

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3352

{ # Specification determining how headers are added to requests or responses.

3353

"headerName": "A String", # The name of the header.

3354

"headerValue": "A String", # The value of the header to add.

3355

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3356

# The default value is false.

3357

},

3358

],

3359

"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.

3365

"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.

3366

# fullPathMatch must be between 1 and 1024 characters.

3367

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3368

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3369

{ # matchRule criteria for request header matches.

3370

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3371

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3372

"headerName": "A String", # The name of the HTTP header to match.

3373

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3374

# For matching a request's method, use the headerName ":method".

3375

"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.

3376

# The default setting is false.

3377

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3378

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3379

"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.

3380

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3381

"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.

3382

# For example for a range [-5, 0]

3383

# - -3 will match.

3384

# - 0 will not match.

3385

# - 0.25 will not match.

3386

# - -3someString will not match.

3387

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3388

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3389

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3390

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3391

},

3392

"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

3393

# 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.

3394

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3395

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3396

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3397

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3398

},

3399

],

3400

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3401

# The default value is false.

3402

# ignoreCase must not be used with regexMatch.

3403

"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.

3404

# 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.

3405

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3406

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3407

{ # 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.

3408

# 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.

3409

# 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.

3410

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3411

# This list must not be empty and can have at the most 64 entries.

3412

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3413

"name": "A String", # Name of metadata label.

3414

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3415

"value": "A String", # The value of the label must match the specified value.

3416

# value can have a maximum length of 1024 characters.

3417

},

3418

],

3419

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3420

# Supported values are:

3421

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3422

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3423

},

3424

],

3425

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3426

# The value must be between 1 and 1024 characters.

3427

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3428

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3429

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3430

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3431

# Only one of presentMatch, exactMatch or regexMatch must be set.

3432

"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.

3433

"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.

3434

# Only one of presentMatch, exactMatch or regexMatch must be set.

3435

"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

3436

# Only one of presentMatch, exactMatch or regexMatch must be set.

3437

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3438

},

3439

],

3440

"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

3441

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3442

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3443

},

3444

],

3445

"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.

3446

# 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.

3447

# 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.

3448

"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.

3449

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3450

"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

3451

"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.

3452

# Default is false.

3453

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3454

"A String",

3455

],

3456

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3457

"A String",

3458

],

3459

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3460

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3461

"A String",

3462

],

3463

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3464

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3465

"A String",

3466

],

3467

"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.

3468

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3469

"A String",

3470

],

3471

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3472

},

3473

"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.

3474

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3475

"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.

3476

"httpStatus": 42, # The HTTP status code used to abort the request.

3477

# The value must be between 200 and 599 inclusive.

3478

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3479

# The value must be between 0.0 and 100.0 inclusive.

3480

},

3481

"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.

3482

"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.

3483

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3484

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3485

},

3486

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3487

# The value must be between 0.0 and 100.0 inclusive.

3488

},

3489

},

3490

"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.

3491

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3492

},

3493

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3494

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3495

"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.

3496

# 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.

3497

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3498

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3499

},

3500

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3501

# - 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.

3502

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3503

# -

3504

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3505

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3506

# - 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.

3507

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3508

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3509

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3510

# - 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.

3515

# If not specified, will use the largest timeout among all backend services associated with the route.

3516

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3517

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3518

},

3519

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3520

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3521

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3522

# The value must be between 1 and 255 characters.

3523

"pathPrefixRewrite": "A String", # Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.

3524

# The value must be between 1 and 1024 characters.

3525

},

3526

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.

3527

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

3528

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

3529

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

3530

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService.

3531

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3532

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3533

{ # Specification determining how headers are added to requests or responses.

3534

"headerName": "A String", # The name of the header.

3535

"headerValue": "A String", # The value of the header to add.

3536

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3537

# The default value is false.

3538

},

3539

],

3540

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3541

"A String",

3542

],

3543

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3544

{ # Specification determining how headers are added to requests or responses.

3545

"headerName": "A String", # The name of the header.

3546

"headerValue": "A String", # The value of the header to add.

3547

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3548

# The default value is false.

3549

},

3550

],

3551

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3556

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

3557

# The value must be between 0 and 1000

},

],

},

"service": "A String", # The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.

3562

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3563

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3564

# If urlRedirect is specified, service or routeAction must not be set.

3565

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3566

# The value must be between 1 and 255 characters.

3567

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3568

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3569

# The default is set to false.

3570

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3571

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3572

# The value must be between 1 and 1024 characters.

3573

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3574

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3575

# The value must be between 1 and 1024 characters.

3576

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3577

# Supported values are:

3578

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3579

# - FOUND, which corresponds to 302.

3580

# - SEE_OTHER which corresponds to 303.

3581

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3582

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3583

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3584

# The default is set to false.

},

},

],

},

],

"region": "A String", # [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

3591

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3592

"tests": [ # The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.

3593

{ # Message for the expected URL mappings.

3594

"description": "A String", # Description of this test case.

3595

"host": "A String", # Host portion of the URL.

3596

"path": "A String", # Path portion of the URL.

3597

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

3598

},

3599

],

3600

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3601

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3602

"kind": "compute#urlMapList", # Type of resource.

3603

"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.

3604

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3605

"warning": { # [Output Only] Informational warning message.

3606

"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.

3607

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3608

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3609

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3610

"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).

3611

"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]

3612

},

3613

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3614

"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]

3615

},

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>

3621

<pre>Retrieves the next page of results.

3622

3623

Args:

3624

previous_request: The request for the previous page. (required)

3625

previous_response: The response from the request for the previous page. (required)

3626

3627

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3628

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3629

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]

3634

<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]

3635

<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]

3636

3637

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3638

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

3639

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3640

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3641

The object takes the form of:

3642

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3643

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3644

#

3645

# Google Compute Engine has two URL Map resources:

3646

#

3647

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3648

#

3649

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3650

#

3651

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3652

#

3653

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3654

#

3655

# 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.

3656

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3657

"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.

3658

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3659

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3660

"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

3661

"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.

3662

# Default is false.

3663

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3664

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3665

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3666

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3667

"A String",

3668

],

3669

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3670

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3671

"A String",

3672

],

3673

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3674

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3675

"A String",

3676

],

3677

"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.

3678

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3679

"A String",

3680

],

3681

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3682

},

3683

"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.

3684

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3685

"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.

3686

"httpStatus": 42, # The HTTP status code used to abort the request.

3687

# The value must be between 200 and 599 inclusive.

3688

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3689

# The value must be between 0.0 and 100.0 inclusive.

3690

},

3691

"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.

3692

"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.

3693

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3694

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3695

},

3696

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3697

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3698

},

3699

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3700

"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.

3701

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3702

},

3703

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3704

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3705

"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.

3706

# 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.

3707

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3708

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

3709

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3710

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3711

# - 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.

3712

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3713

# -

3714

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3715

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3716

# - 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.

3717

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3718

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3719

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3720

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3721

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3722

],

3723

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3724

"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.

3725

# If not specified, will use the largest timeout among all backend services associated with the route.

3726

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3727

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3728

},

3729

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3730

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3731

"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]

3732

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3733

"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.

3734

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3735

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3736

"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.

3737

# 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.

3738

{ # 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

3739

"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.

3740

"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.

3741

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3742

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3743

{ # Specification determining how headers are added to requests or responses.

3744

"headerName": "A String", # The name of the header.

3745

"headerValue": "A String", # The value of the header to add.

3746

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3747

# The default value is false.

3748

},

3749

],

3750

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3751

"A String",

3752

],

3753

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3754

{ # Specification determining how headers are added to requests or responses.

3755

"headerName": "A String", # The name of the header.

3756

"headerValue": "A String", # The value of the header to add.

3757

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3758

# The default value is false.

3759

},

3760

],

3761

"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) .

3766

# 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.

3767

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3768

},

3769

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3770

},

3771

"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.

3772

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3773

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3774

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3775

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3776

# The value must be between 1 and 255 characters.

3777

"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.

3778

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3779

# The default is set to false.

3780

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3781

# 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.

3782

# The value must be between 1 and 1024 characters.

3783

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3784

# 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.

3785

# The value must be between 1 and 1024 characters.

3786

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3787

# Supported values are:

3788

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3789

# - FOUND, which corresponds to 302.

3790

# - SEE_OTHER which corresponds to 303.

3791

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3792

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3793

"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.

3794

# The default is set to false.

3795

},

3796

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3797

"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.

3798

#

3799

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3800

"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.

3801

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3802

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3803

{ # Specification determining how headers are added to requests or responses.

3804

"headerName": "A String", # The name of the header.

3805

"headerValue": "A String", # The value of the header to add.

3806

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3807

# The default value is false.

3808

},

3809

],

3810

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3811

"A String",

3812

],

3813

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3814

{ # Specification determining how headers are added to requests or responses.

3815

"headerName": "A String", # The name of the header.

3816

"headerValue": "A String", # The value of the header to add.

3817

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3818

# The default value is false.

3819

},

3820

],

3821

"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.

3826

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3827

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3828

"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 ..

3829

"A String",

3830

],

3831

"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.

3832

},

3833

],

3834

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3835

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3836

"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.

3837

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3838

{ # 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.

3839

"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.

3840

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3841

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3842

"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

3843

"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.

3844

# Default is false.

3845

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3846

"A String",

3847

],

3848

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3849

"A String",

3850

],

3851

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3852

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3853

"A String",

3854

],

3855

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3856

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3857

"A String",

3858

],

3859

"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.

3860

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3861

"A String",

3862

],

3863

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3864

},

3865

"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.

3866

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3867

"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.

3868

"httpStatus": 42, # The HTTP status code used to abort the request.

3869

# The value must be between 200 and 599 inclusive.

3870

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3871

# The value must be between 0.0 and 100.0 inclusive.

3872

},

3873

"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.

3874

"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.

3875

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3876

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3877

},

3878

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3879

# The value must be between 0.0 and 100.0 inclusive.

3880

},

3881

},

3882

"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.

3883

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3884

},

3885

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3886

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3887

"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.

3888

# 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.

3889

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3890

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3891

},

3892

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3893

# - 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.

3894

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3895

# -

3896

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3897

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3898

# - 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.

3899

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3900

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3901

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3902

# - 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.

3907

# If not specified, will use the largest timeout among all backend services associated with the route.

3908

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3909

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3910

},

3911

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3912

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3913

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3914

# The value must be between 1 and 255 characters.

3915

"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.

3916

# The value must be between 1 and 1024 characters.

3917

},

3918

"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.

3919

# 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.

3920

{ # 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

3921

"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.

3922

"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.

3923

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3924

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3925

{ # Specification determining how headers are added to requests or responses.

3926

"headerName": "A String", # The name of the header.

3927

"headerValue": "A String", # The value of the header to add.

3928

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3929

# The default value is false.

3930

},

3931

],

3932

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3933

"A String",

3934

],

3935

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3936

{ # Specification determining how headers are added to requests or responses.

3937

"headerName": "A String", # The name of the header.

3938

"headerValue": "A String", # The value of the header to add.

3939

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3940

# The default value is false.

3941

},

3942

],

3943

"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) .

3948

# 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.

3949

# 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:

3954

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3955

# - compute/v1/projects/project/global/backendServices/backendService

3956

# - 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.

3957

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3958

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3959

# - compute.backendBuckets.use

3960

# - compute.backendServices.use

3961

"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.

3962

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3963

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3964

# The value must be between 1 and 255 characters.

3965

"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.

3966

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3967

# The default is set to false.

3968

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3969

# 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.

3970

# The value must be between 1 and 1024 characters.

3971

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3972

# 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.

3973

# The value must be between 1 and 1024 characters.

3974

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3975

# Supported values are:

3976

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3977

# - FOUND, which corresponds to 302.

3978

# - SEE_OTHER which corresponds to 303.

3979

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3980

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3981

"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.

3982

# The default is set to false.

3983

},

3984

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3985

"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.

3986

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3987

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3988

{ # Specification determining how headers are added to requests or responses.

3989

"headerName": "A String", # The name of the header.

3990

"headerValue": "A String", # The value of the header to add.

3991

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3992

# The default value is false.

3993

},

3994

],

3995

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3996

"A String",

3997

],

3998

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3999

{ # Specification determining how headers are added to requests or responses.

4000

"headerName": "A String", # The name of the header.

4001

"headerValue": "A String", # The value of the header to add.

4002

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4003

# The default value is false.

4004

},

4005

],

4006

"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.

4011

"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.

4012

# 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.

4013

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4014

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4015

"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.

4016

"A String",

4017

],

4018

"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.

4019

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4020

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4021

"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

4022

"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.

4023

# Default is false.

4024

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4025

"A String",

4026

],

4027

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4028

"A String",

4029

],

4030

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4031

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4032

"A String",

4033

],

4034

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4035

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4036

"A String",

4037

],

4038

"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.

4039

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4040

"A String",

4041

],

4042

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4043

},

4044

"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.

4045

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4046

"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.

4047

"httpStatus": 42, # The HTTP status code used to abort the request.

4048

# The value must be between 200 and 599 inclusive.

4049

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4050

# The value must be between 0.0 and 100.0 inclusive.

4051

},

4052

"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.

4053

"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.

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

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4058

# The value must be between 0.0 and 100.0 inclusive.

4059

},

4060

},

4061

"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.

4062

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4063

},

4064

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4065

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4066

"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.

4067

# 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.

4068

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4069

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4070

},

4071

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4072

# - 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.

4073

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4074

# -

4075

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4076

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4077

# - 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.

4078

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4079

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4080

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4081

# - 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.

4086

# If not specified, will use the largest timeout among all backend services associated with the route.

4087

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4088

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4089

},

4090

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4091

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4092

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4093

# The value must be between 1 and 255 characters.

4094

"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.

4095

# The value must be between 1 and 1024 characters.

4096

},

4097

"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.

4098

# 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.

4099

{ # 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

4100

"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.

4101

"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.

4102

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4103

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4104

{ # Specification determining how headers are added to requests or responses.

4105

"headerName": "A String", # The name of the header.

4106

"headerValue": "A String", # The value of the header to add.

4107

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4108

# The default value is false.

4109

},

4110

],

4111

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4112

"A String",

4113

],

4114

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4115

{ # Specification determining how headers are added to requests or responses.

4116

"headerName": "A String", # The name of the header.

4117

"headerValue": "A String", # The value of the header to add.

4118

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4119

# The default value is false.

4120

},

4121

],

4122

"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) .

4127

# 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.

4128

# 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.

4133

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4134

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4135

# If urlRedirect is specified, service or routeAction must not be set.

4136

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4137

# The value must be between 1 and 255 characters.

4138

"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.

4139

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4140

# The default is set to false.

4141

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4142

# 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.

4143

# The value must be between 1 and 1024 characters.

4144

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4145

# 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.

4146

# The value must be between 1 and 1024 characters.

4147

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4148

# Supported values are:

4149

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4150

# - FOUND, which corresponds to 302.

4151

# - SEE_OTHER which corresponds to 303.

4152

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4153

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4154

"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.

4155

# 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.

4160

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4161

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4162

"description": "A String", # The short description conveying the intent of this routeRule.

4163

# The description can have a maximum length of 1024 characters.

4164

"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.

4165

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4166

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4167

{ # Specification determining how headers are added to requests or responses.

4168

"headerName": "A String", # The name of the header.

4169

"headerValue": "A String", # The value of the header to add.

4170

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4171

# The default value is false.

4172

},

4173

],

4174

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4175

"A String",

4176

],

4177

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4178

{ # Specification determining how headers are added to requests or responses.

4179

"headerName": "A String", # The name of the header.

4180

"headerValue": "A String", # The value of the header to add.

4181

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4182

# The default value is false.

4183

},

4184

],

4185

"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.

4191

"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.

4192

# fullPathMatch must be between 1 and 1024 characters.

4193

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4194

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4195

{ # matchRule criteria for request header matches.

4196

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4197

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4198

"headerName": "A String", # The name of the HTTP header to match.

4199

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4200

# For matching a request's method, use the headerName ":method".

4201

"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.

4202

# The default setting is false.

4203

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4204

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4205

"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.

4206

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4207

"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.

4208

# For example for a range [-5, 0]

4209

# - -3 will match.

4210

# - 0 will not match.

4211

# - 0.25 will not match.

4212

# - -3someString will not match.

4213

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4214

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4215

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4216

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4217

},

4218

"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

4219

# 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.

4220

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4221

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4222

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4223

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4224

},

4225

],

4226

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4227

# The default value is false.

4228

# ignoreCase must not be used with regexMatch.

4229

"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.

4230

# 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.

4231

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4232

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4233

{ # 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.

4234

# 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.

4235

# 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.

4236

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4237

# This list must not be empty and can have at the most 64 entries.

4238

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4239

"name": "A String", # Name of metadata label.

4240

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4241

"value": "A String", # The value of the label must match the specified value.

4242

# value can have a maximum length of 1024 characters.

4243

},

4244

],

4245

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4246

# Supported values are:

4247

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4248

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4249

},

4250

],

4251

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4252

# The value must be between 1 and 1024 characters.

4253

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4254

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4255

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4256

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4257

# Only one of presentMatch, exactMatch or regexMatch must be set.

4258

"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.

4259

"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.

4260

# Only one of presentMatch, exactMatch or regexMatch must be set.

4261

"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

4262

# Only one of presentMatch, exactMatch or regexMatch must be set.

4263

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4264

},

4265

],

4266

"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

4267

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4268

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4269

},

4270

],

4271

"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.

4272

# 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.

4273

# 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.

4274

"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.

4275

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4276

"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

4277

"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.

4278

# Default is false.

4279

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4280

"A String",

4281

],

4282

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4283

"A String",

4284

],

4285

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4286

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4287

"A String",

4288

],

4289

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4290

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4291

"A String",

4292

],

4293

"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.

4294

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4295

"A String",

4296

],

4297

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4298

},

4299

"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.

4300

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4301

"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.

4302

"httpStatus": 42, # The HTTP status code used to abort the request.

4303

# The value must be between 200 and 599 inclusive.

4304

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4305

# The value must be between 0.0 and 100.0 inclusive.

4306

},

4307

"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.

4308

"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.

4309

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4310

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4311

},

4312

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4313

# The value must be between 0.0 and 100.0 inclusive.

4314

},

4315

},

4316

"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.

4317

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4318

},

4319

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4320

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4321

"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.

4322

# 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.

4323

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4324

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4325

},

4326

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4327

# - 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.

4328

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4329

# -

4330

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4331

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4332

# - 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.

4333

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4334

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4335

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4336

# - 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.

4341

# If not specified, will use the largest timeout among all backend services associated with the route.

4342

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4343

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4344

},

4345

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4346

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4347

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4348

# The value must be between 1 and 255 characters.

4349

"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.

4350

# The value must be between 1 and 1024 characters.

4351

},

4352

"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.

4353

# 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.

4354

{ # 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

4355

"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.

4356

"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.

4357

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4358

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4359

{ # Specification determining how headers are added to requests or responses.

4360

"headerName": "A String", # The name of the header.

4361

"headerValue": "A String", # The value of the header to add.

4362

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4363

# The default value is false.

4364

},

4365

],

4366

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4367

"A String",

4368

],

4369

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4370

{ # Specification determining how headers are added to requests or responses.

4371

"headerName": "A String", # The name of the header.

4372

"headerValue": "A String", # The value of the header to add.

4373

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4374

# The default value is false.

4375

},

4376

],

4377

"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) .

4382

# 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.

4383

# 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.

4388

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4389

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4390

# If urlRedirect is specified, service or routeAction must not be set.

4391

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4392

# The value must be between 1 and 255 characters.

4393

"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.

4394

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4395

# The default is set to false.

4396

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4397

# 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.

4398

# The value must be between 1 and 1024 characters.

4399

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4400

# 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.

4401

# The value must be between 1 and 1024 characters.

4402

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4403

# Supported values are:

4404

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4405

# - FOUND, which corresponds to 302.

4406

# - SEE_OTHER which corresponds to 303.

4407

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4408

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4409

"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.

4410

# 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.

4417

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4418

"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.

4419

{ # Message for the expected URL mappings.

4420

"description": "A String", # Description of this test case.

4421

"host": "A String", # Host portion of the URL.

4422

"path": "A String", # Path portion of the URL.

4423

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

4424

},

4425

],

4426

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4427

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4428

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.

4429

4430

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.

4431

4432

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]

4433

4434

Returns:

4435

An object of the form:

4436

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4437

{ # Represents an Operation resource.

4438

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4439

# Google Compute Engine has three Operation resources:

4440

#

4441

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4442

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4443

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4444

#

4445

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4446

# - For global operations, use the `globalOperations` resource.

4447

# - For regional operations, use the `regionOperations` resource.

4448

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4449

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4450

# 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]

4451

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4452

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4453

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4454

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4455

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4456

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4457

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4458

"code": "A String", # [Output Only] The error type identifier for this error.

4459

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4460

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4461

},

4462

],

4463

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4464

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4465

"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.

4466

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4467

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4468

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4469

"name": "A String", # [Output Only] Name of the operation.

4470

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4471

"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.

4472

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4473

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4474

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4475

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4476

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4477

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4478

"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.

4479

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4480

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4481

{

4482

"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.

4483

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4484

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4485

{

4486

"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).

4487

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4488

},

4489

],

4490

"message": "A String", # [Output Only] A human-readable description of the warning code.

4491

},

4492

],

4493

"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]

4498

<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]

4499

<pre>Updates the specified UrlMap resource with the data included in the request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4500

4501

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

4502

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4503

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4504

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4505

The object takes the form of:

4506

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4507

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4508

#

4509

# Google Compute Engine has two URL Map resources:

4510

#

4511

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4512

#

4513

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4514

#

4515

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4516

#

4517

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4518

#

4519

# 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.

4520

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4521

"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.

4522

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4523

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4524

"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

4525

"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.

4526

# Default is false.

4527

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4528

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4529

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4530

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4531

"A String",

4532

],

4533

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4534

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4535

"A String",

4536

],

4537

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4538

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4539

"A String",

4540

],

4541

"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.

4542

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4543

"A String",

4544

],

4545

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4546

},

4547

"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.

4548

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4549

"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.

4550

"httpStatus": 42, # The HTTP status code used to abort the request.

4551

# The value must be between 200 and 599 inclusive.

4552

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4553

# The value must be between 0.0 and 100.0 inclusive.

4554

},

4555

"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.

4556

"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.

4557

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4558

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4559

},

4560

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4561

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4562

},

4563

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4564

"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.

4565

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4566

},

4567

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4568

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4569

"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.

4570

# 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.

4571

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4572

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

4573

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4574

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4575

# - 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.

4576

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4577

# -

4578

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4579

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4580

# - 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.

4581

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4582

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4583

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4584

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4585

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4586

],

4587

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4588

"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.

4589

# If not specified, will use the largest timeout among all backend services associated with the route.

4590

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4591

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4592

},

4593

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4594

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4595

"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]

4596

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4597

"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.

4598

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4599

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4600

"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.

4601

# 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.

4602

{ # 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

4603

"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.

4604

"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.

4605

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4606

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4607

{ # Specification determining how headers are added to requests or responses.

4608

"headerName": "A String", # The name of the header.

4609

"headerValue": "A String", # The value of the header to add.

4610

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4611

# The default value is false.

4612

},

4613

],

4614

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4615

"A String",

4616

],

4617

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4618

{ # Specification determining how headers are added to requests or responses.

4619

"headerName": "A String", # The name of the header.

4620

"headerValue": "A String", # The value of the header to add.

4621

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4622

# The default value is false.

4623

},

4624

],

4625

"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) .

4630

# 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.

4631

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4632

},

4633

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4634

},

4635

"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.

4636

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4637

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4638

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4639

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4640

# The value must be between 1 and 255 characters.

4641

"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.

4642

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4643

# The default is set to false.

4644

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4645

# 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.

4646

# The value must be between 1 and 1024 characters.

4647

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4648

# 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.

4649

# The value must be between 1 and 1024 characters.

4650

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4651

# Supported values are:

4652

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4653

# - FOUND, which corresponds to 302.

4654

# - SEE_OTHER which corresponds to 303.

4655

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4656

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4657

"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.

4658

# The default is set to false.

4659

},

4660

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4661

"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.

4662

#

4663

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4664

"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.

4665

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4666

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4667

{ # Specification determining how headers are added to requests or responses.

4668

"headerName": "A String", # The name of the header.

4669

"headerValue": "A String", # The value of the header to add.

4670

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4671

# The default value is false.

4672

},

4673

],

4674

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4675

"A String",

4676

],

4677

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4678

{ # Specification determining how headers are added to requests or responses.

4679

"headerName": "A String", # The name of the header.

4680

"headerValue": "A String", # The value of the header to add.

4681

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4682

# The default value is false.

4683

},

4684

],

4685

"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.

4690

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4691

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4692

"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 ..

4693

"A String",

4694

],

4695

"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.

4696

},

4697

],

4698

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4699

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4700

"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.

4701

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4702

{ # 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.

4703

"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.

4704

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4705

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4706

"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

4707

"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.

4708

# Default is false.

4709

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4710

"A String",

4711

],

4712

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4713

"A String",

4714

],

4715

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4716

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4717

"A String",

4718

],

4719

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4720

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4721

"A String",

4722

],

4723

"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.

4724

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4725

"A String",

4726

],

4727

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4728

},

4729

"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.

4730

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4731

"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.

4732

"httpStatus": 42, # The HTTP status code used to abort the request.

4733

# The value must be between 200 and 599 inclusive.

4734

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4735

# The value must be between 0.0 and 100.0 inclusive.

4736

},

4737

"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.

4738

"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.

4739

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4740

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4741

},

4742

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4743

# The value must be between 0.0 and 100.0 inclusive.

4744

},

4745

},

4746

"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.

4747

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4748

},

4749

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4750

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4751

"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.

4752

# 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.

4753

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4754

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4755

},

4756

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4757

# - 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.

4758

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4759

# -

4760

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4761

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4762

# - 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.

4763

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4764

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4765

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4766

# - 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.

4771

# If not specified, will use the largest timeout among all backend services associated with the route.

4772

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4773

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4774

},

4775

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4776

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4777

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4778

# The value must be between 1 and 255 characters.

4779

"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.

4780

# The value must be between 1 and 1024 characters.

4781

},

4782

"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.

4783

# 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.

4784

{ # 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

4785

"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.

4786

"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.

4787

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4788

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4789

{ # Specification determining how headers are added to requests or responses.

4790

"headerName": "A String", # The name of the header.

4791

"headerValue": "A String", # The value of the header to add.

4792

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4793

# The default value is false.

4794

},

4795

],

4796

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4797

"A String",

4798

],

4799

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4800

{ # Specification determining how headers are added to requests or responses.

4801

"headerName": "A String", # The name of the header.

4802

"headerValue": "A String", # The value of the header to add.

4803

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4804

# The default value is false.

4805

},

4806

],

4807

"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) .

4812

# 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.

4813

# 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:

4818

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4819

# - compute/v1/projects/project/global/backendServices/backendService

4820

# - 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.

4821

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4822

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4823

# - compute.backendBuckets.use

4824

# - compute.backendServices.use

4825

"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.

4826

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4827

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4828

# The value must be between 1 and 255 characters.

4829

"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.

4830

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4831

# The default is set to false.

4832

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4833

# 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.

4834

# The value must be between 1 and 1024 characters.

4835

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4836

# 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.

4837

# The value must be between 1 and 1024 characters.

4838

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4839

# Supported values are:

4840

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4841

# - FOUND, which corresponds to 302.

4842

# - SEE_OTHER which corresponds to 303.

4843

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4844

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4845

"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.

4846

# The default is set to false.

4847

},

4848

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4849

"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.

4850

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4851

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4852

{ # Specification determining how headers are added to requests or responses.

4853

"headerName": "A String", # The name of the header.

4854

"headerValue": "A String", # The value of the header to add.

4855

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4856

# The default value is false.

4857

},

4858

],

4859

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4860

"A String",

4861

],

4862

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4863

{ # Specification determining how headers are added to requests or responses.

4864

"headerName": "A String", # The name of the header.

4865

"headerValue": "A String", # The value of the header to add.

4866

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4867

# The default value is false.

4868

},

4869

],

4870

"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.

4875

"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.

4876

# 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.

4877

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4878

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4879

"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.

4880

"A String",

4881

],

4882

"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.

4883

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4884

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4885

"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

4886

"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.

4887

# Default is false.

4888

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4889

"A String",

4890

],

4891

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4892

"A String",

4893

],

4894

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4895

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4896

"A String",

4897

],

4898

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4899

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4900

"A String",

4901

],

4902

"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.

4903

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4904

"A String",

4905

],

4906

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4907

},

4908

"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.

4909

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4910

"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.

4911

"httpStatus": 42, # The HTTP status code used to abort the request.

4912

# The value must be between 200 and 599 inclusive.

4913

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4914

# The value must be between 0.0 and 100.0 inclusive.

4915

},

4916

"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.

4917

"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.

4918

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4919

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4920

},

4921

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4922

# The value must be between 0.0 and 100.0 inclusive.

4923

},

4924

},

4925

"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.

4926

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4927

},

4928

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4929

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4930

"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.

4931

# 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.

4932

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4933

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4934

},

4935

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4936

# - 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.

4937

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4938

# -

4939

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4940

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4941

# - 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.

4942

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4943

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4944

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4945

# - 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.

4950

# If not specified, will use the largest timeout among all backend services associated with the route.

4951

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4952

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4953

},

4954

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4955

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4956

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4957

# The value must be between 1 and 255 characters.

4958

"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.

4959

# The value must be between 1 and 1024 characters.

4960

},

4961

"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.

4962

# 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.

4963

{ # 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

4964

"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.

4965

"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.

4966

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4967

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4968

{ # Specification determining how headers are added to requests or responses.

4969

"headerName": "A String", # The name of the header.

4970

"headerValue": "A String", # The value of the header to add.

4971

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4972

# The default value is false.

4973

},

4974

],

4975

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4976

"A String",

4977

],

4978

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4979

{ # Specification determining how headers are added to requests or responses.

4980

"headerName": "A String", # The name of the header.

4981

"headerValue": "A String", # The value of the header to add.

4982

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4983

# The default value is false.

4984

},

4985

],

4986

"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) .

4991

# 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.

4992

# 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.

4997

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4998

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4999

# If urlRedirect is specified, service or routeAction must not be set.

5000

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5001

# The value must be between 1 and 255 characters.

5002

"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.

5003

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5004

# The default is set to false.

5005

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5006

# 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.

5007

# The value must be between 1 and 1024 characters.

5008

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5009

# 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.

5010

# The value must be between 1 and 1024 characters.

5011

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5012

# Supported values are:

5013

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5014

# - FOUND, which corresponds to 302.

5015

# - SEE_OTHER which corresponds to 303.

5016

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5017

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5018

"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.

5019

# 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.

5024

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5025

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5026

"description": "A String", # The short description conveying the intent of this routeRule.

5027

# The description can have a maximum length of 1024 characters.

5028

"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.

5029

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5030

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5031

{ # Specification determining how headers are added to requests or responses.

5032

"headerName": "A String", # The name of the header.

5033

"headerValue": "A String", # The value of the header to add.

5034

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5035

# The default value is false.

5036

},

5037

],

5038

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5039

"A String",

5040

],

5041

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5042

{ # Specification determining how headers are added to requests or responses.

5043

"headerName": "A String", # The name of the header.

5044

"headerValue": "A String", # The value of the header to add.

5045

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5046

# The default value is false.

5047

},

5048

],

5049

"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.

5055

"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.

5056

# fullPathMatch must be between 1 and 1024 characters.

5057

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5058

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5059

{ # matchRule criteria for request header matches.

5060

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5061

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5062

"headerName": "A String", # The name of the HTTP header to match.

5063

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5064

# For matching a request's method, use the headerName ":method".

5065

"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.

5066

# The default setting is false.

5067

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5068

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5069

"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.

5070

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5071

"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.

5072

# For example for a range [-5, 0]

5073

# - -3 will match.

5074

# - 0 will not match.

5075

# - 0.25 will not match.

5076

# - -3someString will not match.

5077

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5078

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5079

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5080

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5081

},

5082

"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

5083

# 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.

5084

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5085

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5086

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5087

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5088

},

5089

],

5090

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5091

# The default value is false.

5092

# ignoreCase must not be used with regexMatch.

5093

"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.

5094

# 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.

5095

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5096

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5097

{ # 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.

5098

# 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.

5099

# 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.

5100

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5101

# This list must not be empty and can have at the most 64 entries.

5102

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5103

"name": "A String", # Name of metadata label.

5104

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5105

"value": "A String", # The value of the label must match the specified value.

5106

# value can have a maximum length of 1024 characters.

5107

},

5108

],

5109

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5110

# Supported values are:

5111

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5112

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5113

},

5114

],

5115

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5116

# The value must be between 1 and 1024 characters.

5117

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5118

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5119

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5120

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5121

# Only one of presentMatch, exactMatch or regexMatch must be set.

5122

"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.

5123

"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.

5124

# Only one of presentMatch, exactMatch or regexMatch must be set.

5125

"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

5126

# Only one of presentMatch, exactMatch or regexMatch must be set.

5127

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5128

},

5129

],

5130

"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

5131

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5132

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5133

},

5134

],

5135

"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.

5136

# 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.

5137

# 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.

5138

"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.

5139

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5140

"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

5141

"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.

5142

# Default is false.

5143

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5144

"A String",

5145

],

5146

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5147

"A String",

5148

],

5149

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5150

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5151

"A String",

5152

],

5153

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5154

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5155

"A String",

5156

],

5157

"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.

5158

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5159

"A String",

5160

],

5161

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5162

},

5163

"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.

5164

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5165

"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.

5166

"httpStatus": 42, # The HTTP status code used to abort the request.

5167

# The value must be between 200 and 599 inclusive.

5168

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5169

# The value must be between 0.0 and 100.0 inclusive.

5170

},

5171

"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.

5172

"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.

5173

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5174

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5175

},

5176

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5177

# The value must be between 0.0 and 100.0 inclusive.

5178

},

5179

},

5180

"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.

5181

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5182

},

5183

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5184

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5185

"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.

5186

# 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.

5187

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5188

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5189

},

5190

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5191

# - 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.

5192

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5193

# -

5194

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5195

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5196

# - 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.

5197

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5198

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5199

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5200

# - 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.

5205

# If not specified, will use the largest timeout among all backend services associated with the route.

5206

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5207

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5208

},

5209

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5210

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5211

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5212

# The value must be between 1 and 255 characters.

5213

"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.

5214

# The value must be between 1 and 1024 characters.

5215

},

5216

"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.

5217

# 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.

5218

{ # 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

5219

"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.

5220

"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.

5221

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5222

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5223

{ # Specification determining how headers are added to requests or responses.

5224

"headerName": "A String", # The name of the header.

5225

"headerValue": "A String", # The value of the header to add.

5226

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5227

# The default value is false.

5228

},

5229

],

5230

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5231

"A String",

5232

],

5233

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5234

{ # Specification determining how headers are added to requests or responses.

5235

"headerName": "A String", # The name of the header.

5236

"headerValue": "A String", # The value of the header to add.

5237

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5238

# The default value is false.

5239

},

5240

],

5241

"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) .

5246

# 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.

5247

# 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.

5252

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5253

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5254

# If urlRedirect is specified, service or routeAction must not be set.

5255

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5256

# The value must be between 1 and 255 characters.

5257

"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.

5258

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5259

# The default is set to false.

5260

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5261

# 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.

5262

# The value must be between 1 and 1024 characters.

5263

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5264

# 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.

5265

# The value must be between 1 and 1024 characters.

5266

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5267

# Supported values are:

5268

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5269

# - FOUND, which corresponds to 302.

5270

# - SEE_OTHER which corresponds to 303.

5271

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5272

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5273

"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.

5274

# 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.

5281

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5282

"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.

5283

{ # Message for the expected URL mappings.

5284

"description": "A String", # Description of this test case.

5285

"host": "A String", # Host portion of the URL.

5286

"path": "A String", # Path portion of the URL.

5287

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

5288

},

5289

],

5290

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5291

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5292

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.

5293

5294

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.

5295

5296

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]

5297

5298

Returns:

5299

An object of the form:

5300

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5301

{ # Represents an Operation resource.

5302

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5303

# Google Compute Engine has three Operation resources:

5304

#

5305

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5306

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5307

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5308

#

5309

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5310

# - For global operations, use the `globalOperations` resource.

5311

# - For regional operations, use the `regionOperations` resource.

5312

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5313

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5314

# 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]

5315

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5316

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5317

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5318

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5319

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5320

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5321

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5322

"code": "A String", # [Output Only] The error type identifier for this error.

5323

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5324

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5325

},

5326

],

5327

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5328

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5329

"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.

5330

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5331

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5332

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5333

"name": "A String", # [Output Only] Name of the operation.

5334

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5335

"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.

5336

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5337

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5338

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5339

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5340

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5341

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5342

"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.

5343

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5344

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5345

{

5346

"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.

5347

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5348

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5349

{

5350

"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).

5351

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5352

},

5353

],

5354

"message": "A String", # [Output Only] A human-readable description of the warning code.

5355

},

5356

],

5357

"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]

5362

<code class="details" id="validate">validate(project, urlMap, body=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

5363

<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]

5364

5365

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

5366

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5367

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5368

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5369

The object takes the form of:

5370

5371

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5372

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

5373

#

5374

# Google Compute Engine has two URL Map resources:

5375

#

5376

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

5377

#

5378

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

5379

#

5380

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

5381

#

5382

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

5383

#

5384

# 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.

5385

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5386

"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.

5387

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5388

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5389

"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

5390

"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.

5391

# Default is false.

5392

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5393

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5394

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5395

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5396

"A String",

5397

],

5398

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5399

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5400

"A String",

5401

],

5402

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5403

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5404

"A String",

5405

],

5406

"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.

5407

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5408

"A String",

5409

],

5410

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5411

},

5412

"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.

5413

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5414

"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.

5415

"httpStatus": 42, # The HTTP status code used to abort the request.

5416

# The value must be between 200 and 599 inclusive.

5417

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5418

# The value must be between 0.0 and 100.0 inclusive.

5419

},

5420

"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.

5421

"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.

5422

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5423

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5424

},

5425

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5426

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5427

},

5428

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5429

"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.

5430

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5431

},

5432

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5433

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5434

"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.

5435

# 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.

5436

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5437

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

5438

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5439

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5440

# - 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.

5441

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5442

# -

5443

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5444

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5445

# - 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.

5446

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5447

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5448

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5449

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5450

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5451

],

5452

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5453

"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.

5454

# If not specified, will use the largest timeout among all backend services associated with the route.

5455

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5456

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5457

},

5458

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5459

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5460

"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]

5461

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5462

"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.

5463

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5464

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5465

"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.

5466

# 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.

5467

{ # 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

5468

"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.

5469

"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.

5470

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5471

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5472

{ # Specification determining how headers are added to requests or responses.

5473

"headerName": "A String", # The name of the header.

5474

"headerValue": "A String", # The value of the header to add.

5475

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5476

# The default value is false.

5477

},

5478

],

5479

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5480

"A String",

5481

],

5482

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5483

{ # Specification determining how headers are added to requests or responses.

5484

"headerName": "A String", # The name of the header.

5485

"headerValue": "A String", # The value of the header to add.

5486

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5487

# The default value is false.

5488

},

5489

],

5490

"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) .

5495

# 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.

5496

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5497

},

5498

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5499

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5500

"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.

5501

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5502

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5503

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5504

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5505

# The value must be between 1 and 255 characters.

5506

"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.

5507

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5508

# The default is set to false.

5509

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5510

# 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.

5511

# The value must be between 1 and 1024 characters.

5512

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5513

# 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.

5514

# The value must be between 1 and 1024 characters.

5515

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5516

# Supported values are:

5517

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5518

# - FOUND, which corresponds to 302.

5519

# - SEE_OTHER which corresponds to 303.

5520

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5521

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5522

"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.

5523

# The default is set to false.

5524

},

5525

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5526

"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.

5527

#

5528

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

5529

"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.

5530

# The headerAction specified here take effect after headerAction specified under pathMatcher.

5531

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5532

{ # Specification determining how headers are added to requests or responses.

5533

"headerName": "A String", # The name of the header.

5534

"headerValue": "A String", # The value of the header to add.

5535

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5536

# The default value is false.

5537

},

5538

],

5539

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5540

"A String",

5541

],

5542

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5543

{ # Specification determining how headers are added to requests or responses.

5544

"headerName": "A String", # The name of the header.

5545

"headerValue": "A String", # The value of the header to add.

5546

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5547

# The default value is false.

5548

},

5549

],

5550

"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.

5555

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5556

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5557

"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 ..

5558

"A String",

5559

],

5560

"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.

5561

},

5562

],

5563

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5564

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5565

"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.

5566

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5567

{ # 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.

5568

"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.

5569

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5570

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5571

"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

5572

"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.

5573

# Default is false.

5574

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5575

"A String",

5576

],

5577

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5578

"A String",

5579

],

5580

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5581

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5582

"A String",

5583

],

5584

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5585

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5586

"A String",

5587

],

5588

"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.

5589

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5590

"A String",

5591

],

5592

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5593

},

5594

"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.

5595

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5596

"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.

5597

"httpStatus": 42, # The HTTP status code used to abort the request.

5598

# The value must be between 200 and 599 inclusive.

5599

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5600

# The value must be between 0.0 and 100.0 inclusive.

5601

},

5602

"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.

5603

"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.

5604

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5605

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5606

},

5607

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5608

# The value must be between 0.0 and 100.0 inclusive.

5609

},

5610

},

5611

"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.

5612

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5613

},

5614

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5615

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5616

"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.

5617

# 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.

5618

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5619

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5620

},

5621

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5622

# - 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.

5623

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5624

# -

5625

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5626

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5627

# - 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.

5628

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5629

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5630

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5631

# - 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.

5636

# If not specified, will use the largest timeout among all backend services associated with the route.

5637

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5638

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5639

},

5640

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5641

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5642

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5643

# The value must be between 1 and 255 characters.

5644

"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.

5645

# The value must be between 1 and 1024 characters.

5646

},

5647

"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.

5648

# 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.

5649

{ # 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

5650

"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.

5651

"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.

5652

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5653

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5654

{ # Specification determining how headers are added to requests or responses.

5655

"headerName": "A String", # The name of the header.

5656

"headerValue": "A String", # The value of the header to add.

5657

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5658

# The default value is false.

5659

},

5660

],

5661

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5662

"A String",

5663

],

5664

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5665

{ # Specification determining how headers are added to requests or responses.

5666

"headerName": "A String", # The name of the header.

5667

"headerValue": "A String", # The value of the header to add.

5668

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5669

# The default value is false.

5670

},

5671

],

5672

"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) .

5677

# 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.

5678

# 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:

5683

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

5684

# - compute/v1/projects/project/global/backendServices/backendService

5685

# - 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.

5686

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5687

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

5688

# - compute.backendBuckets.use

5689

# - compute.backendServices.use

5690

"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.

5691

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5692

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5693

# The value must be between 1 and 255 characters.

5694

"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.

5695

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5696

# The default is set to false.

5697

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5698

# 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.

5699

# The value must be between 1 and 1024 characters.

5700

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5701

# 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.

5702

# The value must be between 1 and 1024 characters.

5703

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5704

# Supported values are:

5705

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5706

# - FOUND, which corresponds to 302.

5707

# - SEE_OTHER which corresponds to 303.

5708

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5709

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5710

"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.

5711

# The default is set to false.

5712

},

5713

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5714

"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.

5715

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

5716

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5717

{ # Specification determining how headers are added to requests or responses.

5718

"headerName": "A String", # The name of the header.

5719

"headerValue": "A String", # The value of the header to add.

5720

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5721

# The default value is false.

5722

},

5723

],

5724

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5725

"A String",

5726

],

5727

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5728

{ # Specification determining how headers are added to requests or responses.

5729

"headerName": "A String", # The name of the header.

5730

"headerValue": "A String", # The value of the header to add.

5731

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5732

# The default value is false.

5733

},

5734

],

5735

"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.

5740

"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.

5741

# 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.

5742

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5743

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5744

"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.

5745

"A String",

5746

],

5747

"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.

5748

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5749

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5750

"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

5751

"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.

5752

# Default is false.

5753

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5754

"A String",

5755

],

5756

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5757

"A String",

5758

],

5759

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5760

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5761

"A String",

5762

],

5763

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5764

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5765

"A String",

5766

],

5767

"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.

5768

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5769

"A String",

5770

],

5771

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5772

},

5773

"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.

5774

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5775

"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.

5776

"httpStatus": 42, # The HTTP status code used to abort the request.

5777

# The value must be between 200 and 599 inclusive.

5778

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5779

# The value must be between 0.0 and 100.0 inclusive.

5780

},

5781

"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.

5782

"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.

5783

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5784

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5785

},

5786

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5787

# The value must be between 0.0 and 100.0 inclusive.

5788

},

5789

},

5790

"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.

5791

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5792

},

5793

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5794

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5795

"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.

5796

# 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.

5797

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5798

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5799

},

5800

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5801

# - 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.

5802

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5803

# -

5804

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5805

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5806

# - 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.

5807

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5808

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5809

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5810

# - 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.

5815

# If not specified, will use the largest timeout among all backend services associated with the route.

5816

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5817

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5818

},

5819

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5820

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5821

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5822

# The value must be between 1 and 255 characters.

5823

"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.

5824

# The value must be between 1 and 1024 characters.

5825

},

5826

"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.

5827

# 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.

5828

{ # 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

5829

"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.

5830

"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.

5831

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5832

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5833

{ # Specification determining how headers are added to requests or responses.

5834

"headerName": "A String", # The name of the header.

5835

"headerValue": "A String", # The value of the header to add.

5836

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5837

# The default value is false.

5838

},

5839

],

5840

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5841

"A String",

5842

],

5843

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5844

{ # Specification determining how headers are added to requests or responses.

5845

"headerName": "A String", # The name of the header.

5846

"headerValue": "A String", # The value of the header to add.

5847

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5848

# The default value is false.

5849

},

5850

],

5851

"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) .

5856

# 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.

5857

# 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.

5862

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5863

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5864

# If urlRedirect is specified, service or routeAction must not be set.

5865

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5866

# The value must be between 1 and 255 characters.

5867

"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.

5868

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5869

# The default is set to false.

5870

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5871

# 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.

5872

# The value must be between 1 and 1024 characters.

5873

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5874

# 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.

5875

# The value must be between 1 and 1024 characters.

5876

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5877

# Supported values are:

5878

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5879

# - FOUND, which corresponds to 302.

5880

# - SEE_OTHER which corresponds to 303.

5881

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5882

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5883

"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.

5884

# 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.

5889

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5890

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5891

"description": "A String", # The short description conveying the intent of this routeRule.

5892

# The description can have a maximum length of 1024 characters.

5893

"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.

5894

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5895

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5896

{ # Specification determining how headers are added to requests or responses.

5897

"headerName": "A String", # The name of the header.

5898

"headerValue": "A String", # The value of the header to add.

5899

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5900

# The default value is false.

5901

},

5902

],

5903

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5904

"A String",

5905

],

5906

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5907

{ # Specification determining how headers are added to requests or responses.

5908

"headerName": "A String", # The name of the header.

5909

"headerValue": "A String", # The value of the header to add.

5910

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5911

# The default value is false.

5912

},

5913

],

5914

"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.

5920

"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.

5921

# fullPathMatch must be between 1 and 1024 characters.

5922

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5923

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5924

{ # matchRule criteria for request header matches.

5925

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5926

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5927

"headerName": "A String", # The name of the HTTP header to match.

5928

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5929

# For matching a request's method, use the headerName ":method".

5930

"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.

5931

# The default setting is false.

5932

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5933

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5934

"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.

5935

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5936

"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.

5937

# For example for a range [-5, 0]

5938

# - -3 will match.

5939

# - 0 will not match.

5940

# - 0.25 will not match.

5941

# - -3someString will not match.

5942

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5943

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5944

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5945

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5946

},

5947

"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

5948

# 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.

5949

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5950

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5951

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5952

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5953

},

5954

],

5955

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5956

# The default value is false.

5957

# ignoreCase must not be used with regexMatch.

5958

"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.

5959

# 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.

5960

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5961

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5962

{ # 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.

5963

# 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.

5964

# 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.

5965

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5966

# This list must not be empty and can have at the most 64 entries.

5967

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5968

"name": "A String", # Name of metadata label.

5969

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5970

"value": "A String", # The value of the label must match the specified value.

5971

# value can have a maximum length of 1024 characters.

5972

},

5973

],

5974

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5975

# Supported values are:

5976

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5977

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5978

},

5979

],

5980

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5981

# The value must be between 1 and 1024 characters.

5982

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5983

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5984

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5985

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5986

# Only one of presentMatch, exactMatch or regexMatch must be set.

5987

"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.

5988

"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.

5989

# Only one of presentMatch, exactMatch or regexMatch must be set.

5990

"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

5991

# Only one of presentMatch, exactMatch or regexMatch must be set.

5992

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5993

},

5994

],

5995

"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

5996

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5997

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5998

},

5999

],

6000

"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.

6001

# 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.

6002

# 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.

6003

"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.

6004

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6005

"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

6006

"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.

6007

# Default is false.

6008

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6009

"A String",

6010

],

6011

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6012

"A String",

6013

],

6014

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6015

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6016

"A String",

6017

],

6018

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6019

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6020

"A String",

6021

],

6022

"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.

6023

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6024

"A String",

6025

],

6026

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6027

},

6028

"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.

6029

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

6030

"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.

6031

"httpStatus": 42, # The HTTP status code used to abort the request.

6032

# The value must be between 200 and 599 inclusive.

6033

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6034

# The value must be between 0.0 and 100.0 inclusive.

6035

},

6036

"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.

6037

"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.

6038

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6039

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6040

},

6041

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6042

# The value must be between 0.0 and 100.0 inclusive.

6043

},

6044

},

6045

"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.

6046

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6047

},

6048

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

6049

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6050

"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.

6051

# 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.

6052

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6053

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6054

},

6055

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6056

# - 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.

6057

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6058

# -

6059

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6060

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6061

# - 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.

6062

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6063

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6064

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6065

# - 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.

6070

# If not specified, will use the largest timeout among all backend services associated with the route.

6071

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6072

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6073

},

6074

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6075

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6076

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6077

# The value must be between 1 and 255 characters.

6078

"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.

6079

# The value must be between 1 and 1024 characters.

6080

},

6081

"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.

6082

# 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.

6083

{ # 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

6084

"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.

6085

"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.

6086

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

6087

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6088

{ # Specification determining how headers are added to requests or responses.

6089

"headerName": "A String", # The name of the header.

6090

"headerValue": "A String", # The value of the header to add.

6091

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6092

# The default value is false.

6093

},

6094

],

6095

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6096

"A String",

6097

],

6098

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6099

{ # Specification determining how headers are added to requests or responses.

6100

"headerName": "A String", # The name of the header.

6101

"headerValue": "A String", # The value of the header to add.

6102

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6103

# The default value is false.

6104

},

6105

],

6106

"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) .

6111

# 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.

6112

# 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.

6117

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6118

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

6119

# If urlRedirect is specified, service or routeAction must not be set.

6120

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6121

# The value must be between 1 and 255 characters.

6122

"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.

6123

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6124

# The default is set to false.

6125

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6126

# 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.

6127

# The value must be between 1 and 1024 characters.

6128

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6129

# 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.

6130

# The value must be between 1 and 1024 characters.

6131

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6132

# Supported values are:

6133

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6134

# - FOUND, which corresponds to 302.

6135

# - SEE_OTHER which corresponds to 303.

6136

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6137

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6138

"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.

6139

# 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.

6146

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6147

"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.

6148

{ # Message for the expected URL mappings.

6149

"description": "A String", # Description of this test case.

6150

"host": "A String", # Host portion of the URL.

6151

"path": "A String", # Path portion of the URL.

6152

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

6153

},

6154

],

6155

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}

Returns:

An object of the form:

6161

6162

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6163

"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.

6168

"testFailures": [

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

6169

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6170

"actualService": "A String",

6171

"expectedService": "A String",

6172

"host": "A String",

6173

"path": "A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

6174

},

6175

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6176

"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