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

2019-06-14 16:50:42 -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

84

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

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -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>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

104

Dan O'Meara

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

[diff] [blame]

105

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

106

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

107

Dan O'Meara

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

[diff] [blame]

108

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

112

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

113

<h3>Method Details</h3>

114

Bu Sun Kim

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

[diff] [blame]

115

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

Bu Sun Kim

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

[diff] [blame]

116

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

117

118

Args:

119

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

Dan O'Meara

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

[diff] [blame]

120

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Bu Sun Kim

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

[diff] [blame]

121

Dan O'Meara

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

Dan O'Meara

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

[diff] [blame]

124

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Bu Sun Kim

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

[diff] [blame]

125

Bu Sun Kim

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

[diff] [blame]

126

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]

127

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]

128

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

129

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

130

131

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.

132

133

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

134

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Bu Sun Kim

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

[diff] [blame]

135

136

Returns:

137

An object of the form:

138

139

{

Bu Sun Kim

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

[diff] [blame]

140

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

141

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

142

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

143

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

Dan O'Meara

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

[diff] [blame]

144

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

145

#

146

# Google Compute Engine has two URL Map resources:

147

#

148

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

149

#

150

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

151

#

152

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

153

#

154

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

155

#

156

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

157

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

158

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

159

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

160

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

161

"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

162

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

163

# Default is false.

164

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

165

"A String",

Bu Sun Kim

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

[diff] [blame]

166

],

Bu Sun Kim

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

[diff] [blame]

167

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

168

"A String",

169

],

170

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

171

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

172

"A String",

173

],

174

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

175

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

176

"A String",

177

],

178

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

179

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

180

"A String",

181

],

182

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

183

},

184

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

185

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

186

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

187

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

188

# The value must be between 200 and 599 inclusive.

189

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

190

# The value must be between 0.0 and 100.0 inclusive.

191

},

192

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

193

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

194

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

195

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

196

},

197

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

198

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

199

},

200

},

Bu Sun Kim

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

[diff] [blame]

201

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

202

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

203

},

204

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

205

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

206

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

207

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

208

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

209

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

Bu Sun Kim

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

[diff] [blame]

210

},

Bu Sun Kim

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

[diff] [blame]

211

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

212

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

213

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

214

# -

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

"A String",

Bu Sun Kim

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

[diff] [blame]

223

],

224

},

Bu Sun Kim

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

[diff] [blame]

225

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

226

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

227

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

228

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

229

},

230

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

231

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

232

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

Bu Sun Kim

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

[diff] [blame]

233

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

234

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

235

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

236

},

Bu Sun Kim

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

[diff] [blame]

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

# The default value is false.

249

},

250

],

251

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

252

"A String",

253

],

254

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

255

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

256

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

257

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

258

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

259

# The default value is false.

260

},

261

],

262

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

267

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

268

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

269

},

270

],

Bu Sun Kim

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

[diff] [blame]

271

},

Bu Sun Kim

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

[diff] [blame]

272

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

273

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

274

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

275

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

276

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

277

# The value must be between 1 and 255 characters.

278

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

279

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

280

# The default is set to false.

281

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

282

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

283

# The value must be between 1 and 1024 characters.

284

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

285

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

286

# The value must be between 1 and 1024 characters.

287

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

288

# Supported values are:

289

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

290

# - FOUND, which corresponds to 302.

291

# - SEE_OTHER which corresponds to 303.

292

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

293

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

294

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

295

# The default is set to false.

296

},

297

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

298

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

299

#

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

# The default value is false.

309

},

310

],

311

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

312

"A String",

313

],

314

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

315

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

316

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

317

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

318

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

319

# The default value is false.

320

},

321

],

322

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

327

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

328

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

329

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

330

"A String",

331

],

332

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

333

},

334

],

335

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

336

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

337

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

338

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

339

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

340

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

341

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

342

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

343

"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

344

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

345

# Default is false.

346

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

347

"A String",

348

],

349

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

350

"A String",

351

],

352

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

353

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

354

"A String",

355

],

356

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

357

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

358

"A String",

359

],

360

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

361

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

362

"A String",

363

],

364

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

365

},

366

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

367

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

368

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

369

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

370

# The value must be between 200 and 599 inclusive.

371

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

372

# The value must be between 0.0 and 100.0 inclusive.

373

},

374

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

375

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

376

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

377

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

378

},

379

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

380

# The value must be between 0.0 and 100.0 inclusive.

381

},

382

},

383

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

384

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

385

},

386

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

387

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

388

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

389

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

390

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

391

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

392

},

393

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

394

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

395

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

396

# -

397

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

398

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

399

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

400

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

401

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

402

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

403

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

408

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

409

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

410

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

411

},

412

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

413

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

414

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

415

# The value must be between 1 and 255 characters.

416

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

417

# The value must be between 1 and 1024 characters.

418

},

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

# The default value is false.

431

},

432

],

433

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

434

"A String",

435

],

436

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

437

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

438

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

439

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

440

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

441

# The default value is false.

442

},

443

],

444

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

449

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

450

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

455

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

456

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

457

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

458

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

459

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

460

# - compute.backendBuckets.use

461

# - compute.backendServices.use

462

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

463

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

464

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

465

# The value must be between 1 and 255 characters.

466

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

467

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

468

# The default is set to false.

469

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

470

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

471

# The value must be between 1 and 1024 characters.

472

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

473

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

474

# The value must be between 1 and 1024 characters.

475

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

476

# Supported values are:

477

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

478

# - FOUND, which corresponds to 302.

479

# - SEE_OTHER which corresponds to 303.

480

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

481

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

482

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

483

# The default is set to false.

484

},

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

# The default value is false.

494

},

495

],

496

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

497

"A String",

498

],

499

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

500

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

501

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

502

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

503

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

504

# The default value is false.

505

},

506

],

507

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

512

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

513

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

514

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

515

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

516

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

517

"A String",

518

],

519

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

520

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

521

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

522

"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

523

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

524

# Default is false.

525

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

526

"A String",

527

],

528

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

529

"A String",

530

],

531

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

532

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

533

"A String",

534

],

535

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

536

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

537

"A String",

538

],

539

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

540

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

541

"A String",

542

],

543

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

544

},

545

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

546

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

547

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

548

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

549

# The value must be between 200 and 599 inclusive.

550

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

551

# The value must be between 0.0 and 100.0 inclusive.

552

},

553

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

554

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

555

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

556

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

557

},

558

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

559

# The value must be between 0.0 and 100.0 inclusive.

560

},

561

},

562

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

563

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

564

},

565

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

566

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

567

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

568

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

569

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

570

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

571

},

572

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

573

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

574

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

575

# -

576

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

577

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

578

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

579

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

580

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

581

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

582

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

587

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

588

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

589

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

590

},

591

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

592

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

593

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

594

# The value must be between 1 and 255 characters.

595

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

596

# The value must be between 1 and 1024 characters.

597

},

598

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

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

# The default value is false.

610

},

611

],

612

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

613

"A String",

614

],

615

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

616

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

617

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

618

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

619

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

620

# The default value is false.

621

},

622

],

623

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

628

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

629

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

634

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

635

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

636

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

637

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

638

# The value must be between 1 and 255 characters.

639

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

640

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

641

# The default is set to false.

642

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

643

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

644

# The value must be between 1 and 1024 characters.

645

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

646

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

647

# The value must be between 1 and 1024 characters.

648

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

649

# Supported values are:

650

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

651

# - FOUND, which corresponds to 302.

652

# - SEE_OTHER which corresponds to 303.

653

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

654

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

655

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

656

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

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

# The default value is false.

673

},

674

],

675

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

676

"A String",

677

],

678

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

679

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

680

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

681

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

682

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

683

# The default value is false.

684

},

685

],

686

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

692

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

693

# fullPathMatch must be between 1 and 1024 characters.

694

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

695

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

696

{ # matchRule criteria for request header matches.

697

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

698

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

699

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

700

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

701

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

702

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

703

# The default setting is false.

704

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

705

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

706

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

707

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

708

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

709

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

710

# - -3 will match.

711

# - 0 will not match.

712

# - 0.25 will not match.

713

# - -3someString will not match.

714

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

715

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

716

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

717

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

718

},

719

"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

720

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

721

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

722

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

723

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

724

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

725

},

726

],

727

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

728

# The default value is false.

729

# ignoreCase must not be used with regexMatch.

730

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

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

# value can have a maximum length of 1024 characters.

744

},

745

],

746

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

747

# Supported values are:

748

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

749

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

750

},

751

],

752

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

753

# The value must be between 1 and 1024 characters.

754

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

755

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

756

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

757

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

758

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

759

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

760

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

761

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

762

"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

763

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

764

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

765

},

766

],

767

"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

768

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

769

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

770

},

771

],

772

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

773

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

774

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

775

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

776

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

777

"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

778

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

779

# Default is false.

780

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

781

"A String",

782

],

783

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

784

"A String",

785

],

786

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

787

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

788

"A String",

789

],

790

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

791

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

792

"A String",

793

],

794

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

795

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

796

"A String",

797

],

798

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

799

},

800

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

801

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

802

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

803

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

804

# The value must be between 200 and 599 inclusive.

805

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

806

# The value must be between 0.0 and 100.0 inclusive.

807

},

808

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

809

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

810

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

811

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

812

},

813

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

814

# The value must be between 0.0 and 100.0 inclusive.

815

},

816

},

817

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

818

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

819

},

820

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

821

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

822

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

823

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

824

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

825

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

826

},

827

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

828

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

829

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

830

# -

831

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

832

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

833

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

834

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

835

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

836

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

837

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

842

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

843

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

844

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

845

},

846

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

847

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

848

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

849

# The value must be between 1 and 255 characters.

850

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

851

# The value must be between 1 and 1024 characters.

852

},

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

# The default value is false.

865

},

866

],

867

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

868

"A String",

869

],

870

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

871

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

872

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

873

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

874

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

875

# The default value is false.

876

},

877

],

878

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

883

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

884

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

889

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

890

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

891

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

892

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

893

# The value must be between 1 and 255 characters.

894

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

895

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

896

# The default is set to false.

897

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

898

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

899

# The value must be between 1 and 1024 characters.

900

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

901

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

902

# The value must be between 1 and 1024 characters.

903

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

904

# Supported values are:

905

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

906

# - FOUND, which corresponds to 302.

907

# - SEE_OTHER which corresponds to 303.

908

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

909

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

910

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

911

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

918

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

919

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

920

{ # Message for the expected URL mappings.

921

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

922

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

923

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

924

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

925

},

926

],

927

},

Bu Sun Kim

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

[diff] [blame]

928

],

Bu Sun Kim

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

[diff] [blame]

929

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

930

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

931

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

932

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

Bu Sun Kim

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

[diff] [blame]

933

{

Bu Sun Kim

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

[diff] [blame]

934

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

935

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

936

},

937

],

Bu Sun Kim

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

[diff] [blame]

938

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

939

},

940

},

941

},

Bu Sun Kim

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

[diff] [blame]

942

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

943

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

944

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

945

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

946

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

947

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

948

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

Bu Sun Kim

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

[diff] [blame]

949

{

Bu Sun Kim

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

[diff] [blame]

950

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

951

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

952

},

953

],

Bu Sun Kim

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

[diff] [blame]

954

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

955

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

961

<pre>Retrieves the next page of results.

962

963

Args:

964

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

965

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

966

967

Returns:

Bu Sun Kim

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

[diff] [blame]

968

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

Bu Sun Kim

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

[diff] [blame]

969

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

</pre>

</div>

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

975

<pre>Deletes the specified UrlMap resource.

976

977

Args:

978

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

979

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

Bu Sun Kim

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

[diff] [blame]

980

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.

981

982

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.

983

984

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

985

986

Returns:

987

An object of the form:

988

Bu Sun Kim

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

[diff] [blame]

989

{ # Represents an Operation resource.

990

#

Dan O'Meara

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

[diff] [blame]

991

# Google Compute Engine has three Operation resources:

992

#

993

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

994

#

Bu Sun Kim

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

[diff] [blame]

995

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

996

#

997

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

998

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

999

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

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

#

Dan O'Meara

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

[diff] [blame]

1002

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

1003

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

1004

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

1005

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

1006

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

1007

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

1008

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1009

{

Bu Sun Kim

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

[diff] [blame]

1010

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

1011

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

1012

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1013

},

1014

],

1015

},

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

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

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

1030

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

1031

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

1032

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

1033

{

1034

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

1035

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

1036

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

1037

{

1038

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

1039

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

1040

},

1041

],

1042

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

1043

},

1044

],

1045

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

Sai Cheemalapati

2016-10-21 13:59:49 -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]

1051

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1052

1053

Args:

1054

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

1055

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

1056

1057

Returns:

1058

An object of the form:

1059

Dan O'Meara

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

[diff] [blame]

1060

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1061

#

1062

# Google Compute Engine has two URL Map resources:

1063

#

1064

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

1065

#

1066

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

1067

#

1068

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

1069

#

1070

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

1071

#

1072

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

1073

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

1074

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

1075

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

1076

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

1077

"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

1078

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

1079

# Default is false.

1080

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

1081

"A String",

Bu Sun Kim

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

[diff] [blame]

1082

],

Bu Sun Kim

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

[diff] [blame]

1083

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

1084

"A String",

1085

],

1086

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

1087

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

1088

"A String",

1089

],

1090

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

1091

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

1092

"A String",

1093

],

1094

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

1095

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

1096

"A String",

1097

],

1098

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

1099

},

1100

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

1101

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

1102

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

1103

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

1104

# The value must be between 200 and 599 inclusive.

1105

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

1106

# The value must be between 0.0 and 100.0 inclusive.

1107

},

1108

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

1109

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

1110

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

1111

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

1112

},

1113

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

1114

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1115

},

1116

},

Bu Sun Kim

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

[diff] [blame]

1117

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

1118

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

1119

},

1120

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

1121

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

1122

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

1123

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

1124

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

1125

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

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1126

},

Bu Sun Kim

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

[diff] [blame]

1127

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

1128

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

1129

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

1130

# -

1131

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

1132

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

1133

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

1134

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

1135

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

1136

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

1137

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

1138

"A String",

Bu Sun Kim

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

[diff] [blame]

1139

],

1140

},

Bu Sun Kim

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

[diff] [blame]

1141

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

1142

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

1143

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

1144

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

1145

},

1146

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

1147

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

1148

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

Bu Sun Kim

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

[diff] [blame]

1149

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

1150

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

1151

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1152

},

Bu Sun Kim

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

[diff] [blame]

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

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

1160

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

1161

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

1162

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

1163

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

1164

# The default value is false.

1165

},

1166

],

1167

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

1168

"A String",

1169

],

1170

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

1171

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

1172

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

1173

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

1174

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

1175

# The default value is false.

1176

},

1177

],

1178

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

1183

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

1184

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1185

},

1186

],

Bu Sun Kim

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

[diff] [blame]

1187

},

1188

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

1189

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

1190

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

1191

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

1192

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

1193

# The value must be between 1 and 255 characters.

1194

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

1195

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

1196

# The default is set to false.

1197

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

1198

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

1199

# The value must be between 1 and 1024 characters.

1200

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

1201

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

1202

# The value must be between 1 and 1024 characters.

1203

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

1204

# Supported values are:

1205

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

1206

# - FOUND, which corresponds to 302.

1207

# - SEE_OTHER which corresponds to 303.

1208

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

1209

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

1210

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

1211

# The default is set to false.

1212

},

1213

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

1214

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

1215

#

1216

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

1217

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

1218

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

1219

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

1220

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

1221

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

1222

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

1223

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

1224

# The default value is false.

1225

},

1226

],

1227

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

1228

"A String",

1229

],

1230

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

1231

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

1232

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

1233

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

1234

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

1235

# The default value is false.

1236

},

1237

],

1238

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

1243

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

1244

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

1245

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

1246

"A String",

1247

],

1248

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

1249

},

1250

],

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame^]

1258

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

1259

"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

1260

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

1261

# Default is false.

1262

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

1263

"A String",

1264

],

1265

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

1266

"A String",

1267

],

1268

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

1269

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

1270

"A String",

1271

],

1272

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

1273

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

1274

"A String",

1275

],

1276

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

1277

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

1278

"A String",

1279

],

1280

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

1281

},

1282

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

1283

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

1284

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

1285

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

1286

# The value must be between 200 and 599 inclusive.

1287

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

1288

# The value must be between 0.0 and 100.0 inclusive.

1289

},

1290

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

1291

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

1292

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

1293

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

1294

},

1295

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

1296

# The value must be between 0.0 and 100.0 inclusive.

1297

},

1298

},

1299

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

1300

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

1301

},

1302

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

1303

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

1304

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

1305

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

1306

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

1307

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

1308

},

1309

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

1310

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

1311

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

1312

# -

1313

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

1314

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

1315

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

1316

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

1317

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

1318

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

1319

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

1324

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

1325

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

1326

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

1327

},

1328

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

1329

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

1330

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

1331

# The value must be between 1 and 255 characters.

1332

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

1333

# The value must be between 1 and 1024 characters.

1334

},

1335

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

1336

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

1337

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

1338

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

1339

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

1340

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

1341

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

1342

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

1343

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

1344

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

1345

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

1346

# The default value is false.

1347

},

1348

],

1349

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

1350

"A String",

1351

],

1352

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1353

{ # Specification determining how headers are added to requests or responses.

1354

"headerName": "A String", # The name of the header.

1355

"headerValue": "A String", # The value of the header to add.

1356

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1357

# The default value is false.

1358

},

1359

],

1360

"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) .

1365

# 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.

1366

# 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:

1371

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

1372

# - compute/v1/projects/project/global/backendServices/backendService

1373

# - 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.

1374

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1375

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

1376

# - compute.backendBuckets.use

1377

# - compute.backendServices.use

1378

"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.

1379

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1380

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1381

# The value must be between 1 and 255 characters.

1382

"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.

1383

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1384

# The default is set to false.

1385

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1386

# 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.

1387

# The value must be between 1 and 1024 characters.

1388

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1389

# 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.

1390

# The value must be between 1 and 1024 characters.

1391

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1392

# Supported values are:

1393

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1394

# - FOUND, which corresponds to 302.

1395

# - SEE_OTHER which corresponds to 303.

1396

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1397

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1398

"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.

1399

# The default is set to false.

1400

},

1401

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1402

"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.

1403

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

1404

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1405

{ # Specification determining how headers are added to requests or responses.

1406

"headerName": "A String", # The name of the header.

1407

"headerValue": "A String", # The value of the header to add.

1408

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1409

# The default value is false.

1410

},

1411

],

1412

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1413

"A String",

1414

],

1415

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1416

{ # Specification determining how headers are added to requests or responses.

1417

"headerName": "A String", # The name of the header.

1418

"headerValue": "A String", # The value of the header to add.

1419

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1420

# The default value is false.

1421

},

1422

],

1423

"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.

1428

"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.

1429

# 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.

1430

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1431

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1432

"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.

1433

"A String",

1434

],

1435

"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.

1436

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1437

# 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]

1438

"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

1439

"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.

1440

# Default is false.

1441

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1442

"A String",

1443

],

1444

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1445

"A String",

1446

],

1447

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1448

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1449

"A String",

1450

],

1451

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1452

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1453

"A String",

1454

],

1455

"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.

1456

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1457

"A String",

1458

],

1459

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1460

},

1461

"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.

1462

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1463

"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.

1464

"httpStatus": 42, # The HTTP status code used to abort the request.

1465

# The value must be between 200 and 599 inclusive.

1466

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1467

# The value must be between 0.0 and 100.0 inclusive.

1468

},

1469

"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.

1470

"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.

1471

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1472

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1473

},

1474

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1475

# The value must be between 0.0 and 100.0 inclusive.

1476

},

1477

},

1478

"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.

1479

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1480

},

1481

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1482

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1483

"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.

1484

# 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.

1485

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1486

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1487

},

1488

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1489

# - 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.

1490

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1491

# -

1492

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1493

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1494

# - 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.

1495

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1496

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1497

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1498

# - 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.

1503

# If not specified, will use the largest timeout among all backend services associated with the route.

1504

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1505

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1506

},

1507

"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^]

1508

# 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]

1509

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1510

# The value must be between 1 and 255 characters.

1511

"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.

1512

# The value must be between 1 and 1024 characters.

1513

},

1514

"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.

1515

# 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.

1516

{ # 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

1517

"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.

1518

"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.

1519

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1520

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1521

{ # Specification determining how headers are added to requests or responses.

1522

"headerName": "A String", # The name of the header.

1523

"headerValue": "A String", # The value of the header to add.

1524

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1525

# The default value is false.

1526

},

1527

],

1528

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1529

"A String",

1530

],

1531

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1532

{ # Specification determining how headers are added to requests or responses.

1533

"headerName": "A String", # The name of the header.

1534

"headerValue": "A String", # The value of the header to add.

1535

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1536

# The default value is false.

1537

},

1538

],

1539

"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) .

1544

# 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.

1545

# 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.

1550

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1551

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1552

# If urlRedirect is specified, service or routeAction must not be set.

1553

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1554

# The value must be between 1 and 255 characters.

1555

"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.

1556

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1557

# The default is set to false.

1558

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1559

# 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.

1560

# The value must be between 1 and 1024 characters.

1561

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1562

# 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.

1563

# The value must be between 1 and 1024 characters.

1564

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1565

# Supported values are:

1566

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1567

# - FOUND, which corresponds to 302.

1568

# - SEE_OTHER which corresponds to 303.

1569

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1570

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1571

"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.

1572

# 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.

1577

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1578

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1579

"description": "A String", # The short description conveying the intent of this routeRule.

1580

# The description can have a maximum length of 1024 characters.

1581

"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.

1582

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

1583

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1584

{ # Specification determining how headers are added to requests or responses.

1585

"headerName": "A String", # The name of the header.

1586

"headerValue": "A String", # The value of the header to add.

1587

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1588

# The default value is false.

1589

},

1590

],

1591

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1592

"A String",

1593

],

1594

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1595

{ # Specification determining how headers are added to requests or responses.

1596

"headerName": "A String", # The name of the header.

1597

"headerValue": "A String", # The value of the header to add.

1598

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1599

# The default value is false.

1600

},

1601

],

1602

"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.

1608

"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.

1609

# fullPathMatch must be between 1 and 1024 characters.

1610

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1611

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1612

{ # matchRule criteria for request header matches.

1613

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1614

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1615

"headerName": "A String", # The name of the HTTP header to match.

1616

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1617

# For matching a request's method, use the headerName ":method".

1618

"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.

1619

# The default setting is false.

1620

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1621

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1622

"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.

1623

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1624

"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.

1625

# For example for a range [-5, 0]

1626

# - -3 will match.

1627

# - 0 will not match.

1628

# - 0.25 will not match.

1629

# - -3someString will not match.

1630

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1631

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1632

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1633

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1634

},

1635

"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

1636

# 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.

1637

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1638

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1639

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1640

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1641

},

1642

],

1643

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1644

# The default value is false.

1645

# ignoreCase must not be used with regexMatch.

1646

"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.

1647

# 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.

1648

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1649

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1650

{ # 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.

1651

# 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.

1652

# 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.

1653

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1654

# This list must not be empty and can have at the most 64 entries.

1655

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1656

"name": "A String", # Name of metadata label.

1657

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1658

"value": "A String", # The value of the label must match the specified value.

1659

# value can have a maximum length of 1024 characters.

1660

},

1661

],

1662

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1663

# Supported values are:

1664

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1665

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1666

},

1667

],

1668

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1669

# The value must be between 1 and 1024 characters.

1670

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1671

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1672

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1673

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1674

# Only one of presentMatch, exactMatch or regexMatch must be set.

1675

"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.

1676

"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.

1677

# Only one of presentMatch, exactMatch or regexMatch must be set.

1678

"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

1679

# Only one of presentMatch, exactMatch or regexMatch must be set.

1680

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1681

},

1682

],

1683

"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

1684

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1685

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1686

},

1687

],

1688

"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.

1689

# 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.

1690

# 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.

1691

"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.

1692

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1693

"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

1694

"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.

1695

# Default is false.

1696

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1697

"A String",

1698

],

1699

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1700

"A String",

1701

],

1702

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1703

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1704

"A String",

1705

],

1706

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1707

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1708

"A String",

1709

],

1710

"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.

1711

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1712

"A String",

1713

],

1714

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1715

},

1716

"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.

1717

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1718

"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.

1719

"httpStatus": 42, # The HTTP status code used to abort the request.

1720

# The value must be between 200 and 599 inclusive.

1721

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1722

# The value must be between 0.0 and 100.0 inclusive.

1723

},

1724

"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.

1725

"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.

1726

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1727

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1728

},

1729

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1730

# The value must be between 0.0 and 100.0 inclusive.

1731

},

1732

},

1733

"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.

1734

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1735

},

1736

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1737

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1738

"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.

1739

# 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.

1740

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1741

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1742

},

1743

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1744

# - 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.

1745

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1746

# -

1747

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1748

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1749

# - 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.

1750

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1751

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1752

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1753

# - 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.

1758

# If not specified, will use the largest timeout among all backend services associated with the route.

1759

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1760

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1761

},

1762

"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^]

1763

# 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]

1764

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1765

# The value must be between 1 and 255 characters.

1766

"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.

1767

# The value must be between 1 and 1024 characters.

1768

},

1769

"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.

1770

# 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.

1771

{ # 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

1772

"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.

1773

"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.

1774

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1775

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1776

{ # Specification determining how headers are added to requests or responses.

1777

"headerName": "A String", # The name of the header.

1778

"headerValue": "A String", # The value of the header to add.

1779

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1780

# The default value is false.

1781

},

1782

],

1783

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1784

"A String",

1785

],

1786

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1787

{ # Specification determining how headers are added to requests or responses.

1788

"headerName": "A String", # The name of the header.

1789

"headerValue": "A String", # The value of the header to add.

1790

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1791

# The default value is false.

1792

},

1793

],

1794

"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) .

1799

# 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.

1800

# 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.

1805

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1806

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1807

# If urlRedirect is specified, service or routeAction must not be set.

1808

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1809

# The value must be between 1 and 255 characters.

1810

"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.

1811

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1812

# The default is set to false.

1813

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1814

# 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.

1815

# The value must be between 1 and 1024 characters.

1816

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1817

# 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.

1818

# The value must be between 1 and 1024 characters.

1819

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1820

# Supported values are:

1821

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1822

# - FOUND, which corresponds to 302.

1823

# - SEE_OTHER which corresponds to 303.

1824

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1825

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1826

"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.

1827

# 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.

1834

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1835

"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.

1836

{ # Message for the expected URL mappings.

1837

"description": "A String", # Description of this test case.

1838

"host": "A String", # Host portion of the URL.

1839

"path": "A String", # Path portion of the URL.

1840

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

1841

},

1842

],

1843

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1847

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1848

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

1849

1850

Args:

1851

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1852

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1853

The object takes the form of:

1854

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1855

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1856

#

1857

# Google Compute Engine has two URL Map resources:

1858

#

1859

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1860

#

1861

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1862

#

1863

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1864

#

1865

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1866

#

1867

# 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.

1868

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1869

"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.

1870

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1871

# 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]

1872

"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

1873

"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.

1874

# Default is false.

1875

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1876

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1877

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1878

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1879

"A String",

1880

],

1881

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1882

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1883

"A String",

1884

],

1885

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1886

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1887

"A String",

1888

],

1889

"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.

1890

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1891

"A String",

1892

],

1893

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1894

},

1895

"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.

1896

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1897

"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.

1898

"httpStatus": 42, # The HTTP status code used to abort the request.

1899

# The value must be between 200 and 599 inclusive.

1900

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1901

# The value must be between 0.0 and 100.0 inclusive.

1902

},

1903

"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.

1904

"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.

1905

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1906

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1907

},

1908

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1909

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1910

},

1911

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1912

"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.

1913

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1914

},

1915

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1916

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1917

"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.

1918

# 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.

1919

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1920

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1921

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1922

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1923

# - 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.

1924

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1925

# -

1926

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1927

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1928

# - 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.

1929

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1930

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1931

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1932

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

1933

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1934

],

1935

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1936

"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.

1937

# If not specified, will use the largest timeout among all backend services associated with the route.

1938

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1939

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1940

},

1941

"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^]

1942

# 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]

1943

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1944

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1945

"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.

1946

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1947

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1948

"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.

1949

# 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.

1950

{ # 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

1951

"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.

1952

"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.

1953

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1954

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1955

{ # Specification determining how headers are added to requests or responses.

1956

"headerName": "A String", # The name of the header.

1957

"headerValue": "A String", # The value of the header to add.

1958

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1959

# The default value is false.

1960

},

1961

],

1962

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1963

"A String",

1964

],

1965

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1966

{ # Specification determining how headers are added to requests or responses.

1967

"headerName": "A String", # The name of the header.

1968

"headerValue": "A String", # The value of the header to add.

1969

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1970

# The default value is false.

1971

},

1972

],

1973

"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) .

1978

# 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.

1979

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1980

},

1981

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1982

},

1983

"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.

1984

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1985

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1986

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

1987

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1988

# The value must be between 1 and 255 characters.

1989

"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.

1990

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1991

# The default is set to false.

1992

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1993

# 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.

1994

# The value must be between 1 and 1024 characters.

1995

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1996

# 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.

1997

# The value must be between 1 and 1024 characters.

1998

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1999

# Supported values are:

2000

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2001

# - FOUND, which corresponds to 302.

2002

# - SEE_OTHER which corresponds to 303.

2003

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2004

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2005

"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.

2006

# The default is set to false.

2007

},

2008

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2009

"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.

2010

#

2011

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2012

"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.

2013

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2014

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2015

{ # Specification determining how headers are added to requests or responses.

2016

"headerName": "A String", # The name of the header.

2017

"headerValue": "A String", # The value of the header to add.

2018

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2019

# The default value is false.

2020

},

2021

],

2022

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2023

"A String",

2024

],

2025

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2026

{ # Specification determining how headers are added to requests or responses.

2027

"headerName": "A String", # The name of the header.

2028

"headerValue": "A String", # The value of the header to add.

2029

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2030

# The default value is false.

2031

},

2032

],

2033

"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.

2038

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2039

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2040

"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 ..

2041

"A String",

2042

],

2043

"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.

2044

},

2045

],

2046

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2047

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2048

"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.

2049

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2050

{ # 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.

2051

"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.

2052

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2053

# 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]

2054

"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

2055

"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.

2056

# Default is false.

2057

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2058

"A String",

2059

],

2060

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2061

"A String",

2062

],

2063

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2064

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2065

"A String",

2066

],

2067

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2068

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2069

"A String",

2070

],

2071

"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.

2072

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2073

"A String",

2074

],

2075

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2076

},

2077

"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.

2078

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2079

"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.

2080

"httpStatus": 42, # The HTTP status code used to abort the request.

2081

# The value must be between 200 and 599 inclusive.

2082

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2083

# The value must be between 0.0 and 100.0 inclusive.

2084

},

2085

"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.

2086

"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.

2087

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2088

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2089

},

2090

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2091

# The value must be between 0.0 and 100.0 inclusive.

2092

},

2093

},

2094

"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.

2095

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2096

},

2097

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2098

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2099

"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.

2100

# 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.

2101

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2102

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2103

},

2104

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2105

# - 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.

2106

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2107

# -

2108

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2109

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2110

# - 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.

2111

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2112

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2113

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2114

# - 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.

2119

# If not specified, will use the largest timeout among all backend services associated with the route.

2120

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2121

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2122

},

2123

"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^]

2124

# 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]

2125

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2126

# The value must be between 1 and 255 characters.

2127

"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.

2128

# The value must be between 1 and 1024 characters.

2129

},

2130

"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.

2131

# 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.

2132

{ # 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

2133

"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.

2134

"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.

2135

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2136

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2137

{ # Specification determining how headers are added to requests or responses.

2138

"headerName": "A String", # The name of the header.

2139

"headerValue": "A String", # The value of the header to add.

2140

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2141

# The default value is false.

2142

},

2143

],

2144

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2145

"A String",

2146

],

2147

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2148

{ # Specification determining how headers are added to requests or responses.

2149

"headerName": "A String", # The name of the header.

2150

"headerValue": "A String", # The value of the header to add.

2151

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2152

# The default value is false.

2153

},

2154

],

2155

"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) .

2160

# 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.

2161

# 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:

2166

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2167

# - compute/v1/projects/project/global/backendServices/backendService

2168

# - 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.

2169

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2170

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2171

# - compute.backendBuckets.use

2172

# - compute.backendServices.use

2173

"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.

2174

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2175

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2176

# The value must be between 1 and 255 characters.

2177

"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.

2178

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2179

# The default is set to false.

2180

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2181

# 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.

2182

# The value must be between 1 and 1024 characters.

2183

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2184

# 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.

2185

# The value must be between 1 and 1024 characters.

2186

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2187

# Supported values are:

2188

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2189

# - FOUND, which corresponds to 302.

2190

# - SEE_OTHER which corresponds to 303.

2191

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2192

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2193

"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.

2194

# The default is set to false.

2195

},

2196

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2197

"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.

2198

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2199

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2200

{ # Specification determining how headers are added to requests or responses.

2201

"headerName": "A String", # The name of the header.

2202

"headerValue": "A String", # The value of the header to add.

2203

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2204

# The default value is false.

2205

},

2206

],

2207

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2208

"A String",

2209

],

2210

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2211

{ # Specification determining how headers are added to requests or responses.

2212

"headerName": "A String", # The name of the header.

2213

"headerValue": "A String", # The value of the header to add.

2214

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2215

# The default value is false.

2216

},

2217

],

2218

"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.

2223

"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.

2224

# 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.

2225

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2226

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2227

"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.

2228

"A String",

2229

],

2230

"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.

2231

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2232

# 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]

2233

"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

2234

"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.

2235

# Default is false.

2236

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2237

"A String",

2238

],

2239

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2240

"A String",

2241

],

2242

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2243

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2244

"A String",

2245

],

2246

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2247

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2248

"A String",

2249

],

2250

"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.

2251

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2252

"A String",

2253

],

2254

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2255

},

2256

"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.

2257

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2258

"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.

2259

"httpStatus": 42, # The HTTP status code used to abort the request.

2260

# The value must be between 200 and 599 inclusive.

2261

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2262

# The value must be between 0.0 and 100.0 inclusive.

2263

},

2264

"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.

2265

"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.

2266

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2267

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2268

},

2269

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2270

# The value must be between 0.0 and 100.0 inclusive.

2271

},

2272

},

2273

"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.

2274

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2275

},

2276

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2277

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2278

"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.

2279

# 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.

2280

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2281

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2282

},

2283

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2284

# - 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.

2285

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2286

# -

2287

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2288

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2289

# - 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.

2290

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2291

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2292

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2293

# - 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.

2298

# If not specified, will use the largest timeout among all backend services associated with the route.

2299

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2300

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2301

},

2302

"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^]

2303

# 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]

2304

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2305

# The value must be between 1 and 255 characters.

2306

"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.

2307

# The value must be between 1 and 1024 characters.

2308

},

2309

"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.

2310

# 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.

2311

{ # 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

2312

"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.

2313

"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.

2314

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2315

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2316

{ # Specification determining how headers are added to requests or responses.

2317

"headerName": "A String", # The name of the header.

2318

"headerValue": "A String", # The value of the header to add.

2319

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2320

# The default value is false.

2321

},

2322

],

2323

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2324

"A String",

2325

],

2326

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2327

{ # Specification determining how headers are added to requests or responses.

2328

"headerName": "A String", # The name of the header.

2329

"headerValue": "A String", # The value of the header to add.

2330

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2331

# The default value is false.

2332

},

2333

],

2334

"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) .

2339

# 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.

2340

# 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.

2345

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2346

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2347

# If urlRedirect is specified, service or routeAction must not be set.

2348

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2349

# The value must be between 1 and 255 characters.

2350

"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.

2351

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2352

# The default is set to false.

2353

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2354

# 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.

2355

# The value must be between 1 and 1024 characters.

2356

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2357

# 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.

2358

# The value must be between 1 and 1024 characters.

2359

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2360

# Supported values are:

2361

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2362

# - FOUND, which corresponds to 302.

2363

# - SEE_OTHER which corresponds to 303.

2364

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2365

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2366

"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.

2367

# 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.

2372

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2373

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2374

"description": "A String", # The short description conveying the intent of this routeRule.

2375

# The description can have a maximum length of 1024 characters.

2376

"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.

2377

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2378

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2379

{ # Specification determining how headers are added to requests or responses.

2380

"headerName": "A String", # The name of the header.

2381

"headerValue": "A String", # The value of the header to add.

2382

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2383

# The default value is false.

2384

},

2385

],

2386

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2387

"A String",

2388

],

2389

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2390

{ # Specification determining how headers are added to requests or responses.

2391

"headerName": "A String", # The name of the header.

2392

"headerValue": "A String", # The value of the header to add.

2393

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2394

# The default value is false.

2395

},

2396

],

2397

"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.

2403

"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.

2404

# fullPathMatch must be between 1 and 1024 characters.

2405

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2406

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2407

{ # matchRule criteria for request header matches.

2408

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2409

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2410

"headerName": "A String", # The name of the HTTP header to match.

2411

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2412

# For matching a request's method, use the headerName ":method".

2413

"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.

2414

# The default setting is false.

2415

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2416

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2417

"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.

2418

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2419

"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.

2420

# For example for a range [-5, 0]

2421

# - -3 will match.

2422

# - 0 will not match.

2423

# - 0.25 will not match.

2424

# - -3someString will not match.

2425

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2426

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2427

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2428

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2429

},

2430

"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

2431

# 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.

2432

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2433

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2434

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2435

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2436

},

2437

],

2438

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2439

# The default value is false.

2440

# ignoreCase must not be used with regexMatch.

2441

"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.

2442

# 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.

2443

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2444

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2445

{ # 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.

2446

# 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.

2447

# 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.

2448

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2449

# This list must not be empty and can have at the most 64 entries.

2450

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2451

"name": "A String", # Name of metadata label.

2452

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2453

"value": "A String", # The value of the label must match the specified value.

2454

# value can have a maximum length of 1024 characters.

2455

},

2456

],

2457

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2458

# Supported values are:

2459

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2460

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2461

},

2462

],

2463

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2464

# The value must be between 1 and 1024 characters.

2465

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2466

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2467

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2468

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2469

# Only one of presentMatch, exactMatch or regexMatch must be set.

2470

"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.

2471

"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.

2472

# Only one of presentMatch, exactMatch or regexMatch must be set.

2473

"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

2474

# Only one of presentMatch, exactMatch or regexMatch must be set.

2475

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2476

},

2477

],

2478

"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

2479

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2480

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2481

},

2482

],

2483

"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.

2484

# 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.

2485

# 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.

2486

"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.

2487

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2488

"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

2489

"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.

2490

# Default is false.

2491

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2492

"A String",

2493

],

2494

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2495

"A String",

2496

],

2497

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2498

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2499

"A String",

2500

],

2501

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2502

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2503

"A String",

2504

],

2505

"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.

2506

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2507

"A String",

2508

],

2509

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2510

},

2511

"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.

2512

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2513

"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.

2514

"httpStatus": 42, # The HTTP status code used to abort the request.

2515

# The value must be between 200 and 599 inclusive.

2516

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2517

# The value must be between 0.0 and 100.0 inclusive.

2518

},

2519

"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.

2520

"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.

2521

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2522

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2523

},

2524

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2525

# The value must be between 0.0 and 100.0 inclusive.

2526

},

2527

},

2528

"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.

2529

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2530

},

2531

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2532

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2533

"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.

2534

# 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.

2535

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2536

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2537

},

2538

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2539

# - 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.

2540

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2541

# -

2542

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2543

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2544

# - 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.

2545

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2546

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2547

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2548

# - 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.

2553

# If not specified, will use the largest timeout among all backend services associated with the route.

2554

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2555

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2556

},

2557

"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^]

2558

# 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]

2559

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2560

# The value must be between 1 and 255 characters.

2561

"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.

2562

# The value must be between 1 and 1024 characters.

2563

},

2564

"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.

2565

# 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.

2566

{ # 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

2567

"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.

2568

"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.

2569

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2570

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2571

{ # Specification determining how headers are added to requests or responses.

2572

"headerName": "A String", # The name of the header.

2573

"headerValue": "A String", # The value of the header to add.

2574

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2575

# The default value is false.

2576

},

2577

],

2578

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2579

"A String",

2580

],

2581

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2582

{ # Specification determining how headers are added to requests or responses.

2583

"headerName": "A String", # The name of the header.

2584

"headerValue": "A String", # The value of the header to add.

2585

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2586

# The default value is false.

2587

},

2588

],

2589

"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) .

2594

# 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.

2595

# 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.

2600

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2601

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2602

# If urlRedirect is specified, service or routeAction must not be set.

2603

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2604

# The value must be between 1 and 255 characters.

2605

"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.

2606

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2607

# The default is set to false.

2608

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2609

# 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.

2610

# The value must be between 1 and 1024 characters.

2611

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2612

# 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.

2613

# The value must be between 1 and 1024 characters.

2614

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2615

# Supported values are:

2616

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2617

# - FOUND, which corresponds to 302.

2618

# - SEE_OTHER which corresponds to 303.

2619

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2620

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2621

"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.

2622

# 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.

2629

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2630

"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.

2631

{ # Message for the expected URL mappings.

2632

"description": "A String", # Description of this test case.

2633

"host": "A String", # Host portion of the URL.

2634

"path": "A String", # Path portion of the URL.

2635

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

2636

},

2637

],

2638

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2639

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2640

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.

2641

2642

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.

2643

2644

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2645

2646

Returns:

2647

An object of the form:

2648

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2649

{ # Represents an Operation resource.

2650

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2651

# Google Compute Engine has three Operation resources:

2652

#

2653

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2654

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2655

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2656

#

2657

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2658

# - For global operations, use the `globalOperations` resource.

2659

# - For regional operations, use the `regionOperations` resource.

2660

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2661

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2662

# 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]

2663

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2664

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2665

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2666

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2667

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2668

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2669

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2670

"code": "A String", # [Output Only] The error type identifier for this error.

2671

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2672

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2673

},

2674

],

2675

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2676

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2677

"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.

2678

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2679

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2680

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2681

"name": "A String", # [Output Only] Name of the operation.

2682

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2683

"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.

2684

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2685

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2686

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2687

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2688

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2689

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2690

"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.

2691

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2692

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2693

{

2694

"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.

2695

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2696

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2697

{

2698

"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).

2699

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2700

},

2701

],

2702

"message": "A String", # [Output Only] A human-readable description of the warning code.

2703

},

2704

],

2705

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2710

<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2711

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

2712

2713

Args:

2714

project: string, Project ID for this request. (required)

2715

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2716

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2717

The object takes the form of:

2718

2719

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2720

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

2721

"path": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2722

}

2723

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2724

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.

2725

2726

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.

2727

2728

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2729

2730

Returns:

2731

An object of the form:

2732

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2733

{ # Represents an Operation resource.

2734

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2735

# Google Compute Engine has three Operation resources:

2736

#

2737

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2738

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2739

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2740

#

2741

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2742

# - For global operations, use the `globalOperations` resource.

2743

# - For regional operations, use the `regionOperations` resource.

2744

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2745

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2746

# 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]

2747

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2748

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2749

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2750

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2751

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2752

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2753

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2754

"code": "A String", # [Output Only] The error type identifier for this error.

2755

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2756

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2757

},

2758

],

2759

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2760

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2761

"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.

2762

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2763

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2764

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2765

"name": "A String", # [Output Only] Name of the operation.

2766

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2767

"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.

2768

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2769

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2770

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2771

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2772

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2773

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2774

"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.

2775

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2776

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2777

{

2778

"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.

2779

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2780

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2781

{

2782

"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).

2783

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2784

},

2785

],

2786

"message": "A String", # [Output Only] A human-readable description of the warning code.

2787

},

2788

],

2789

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2794

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2795

<pre>Retrieves the list of UrlMap resources available to the specified project.

2796

2797

Args:

2798

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2799

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 `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2800

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2801

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2802

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2803

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2804

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2805

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) ```

2806

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`)

2807

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2808

2809

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.

2810

2811

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2812

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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2813

2814

Returns:

2815

An object of the form:

2816

2817

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2818

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2819

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2820

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2821

#

2822

# Google Compute Engine has two URL Map resources:

2823

#

2824

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2825

#

2826

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2827

#

2828

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2829

#

2830

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2831

#

2832

# 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.

2833

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2834

"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.

2835

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

2836

# 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]

2837

"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

2838

"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.

2839

# Default is false.

2840

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2841

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2842

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2843

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2844

"A String",

2845

],

2846

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2847

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2848

"A String",

2849

],

2850

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2851

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2852

"A String",

2853

],

2854

"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.

2855

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2856

"A String",

2857

],

2858

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2859

},

2860

"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.

2861

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2862

"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.

2863

"httpStatus": 42, # The HTTP status code used to abort the request.

2864

# The value must be between 200 and 599 inclusive.

2865

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2866

# The value must be between 0.0 and 100.0 inclusive.

2867

},

2868

"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.

2869

"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.

2870

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2871

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2872

},

2873

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2874

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2875

},

2876

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2877

"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.

2878

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2879

},

2880

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2881

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2882

"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.

2883

# 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.

2884

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2885

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2886

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2887

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2888

# - 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.

2889

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2890

# -

2891

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2892

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2893

# - 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.

2894

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2895

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2896

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2897

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2898

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2899

],

2900

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2901

"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.

2902

# If not specified, will use the largest timeout among all backend services associated with the route.

2903

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2904

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2905

},

2906

"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^]

2907

# 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]

2908

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2909

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2910

"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.

2911

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2912

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2913

"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.

2914

# 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.

2915

{ # 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

2916

"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.

2917

"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.

2918

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2919

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2920

{ # Specification determining how headers are added to requests or responses.

2921

"headerName": "A String", # The name of the header.

2922

"headerValue": "A String", # The value of the header to add.

2923

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2924

# The default value is false.

2925

},

2926

],

2927

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2928

"A String",

2929

],

2930

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2931

{ # Specification determining how headers are added to requests or responses.

2932

"headerName": "A String", # The name of the header.

2933

"headerValue": "A String", # The value of the header to add.

2934

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2935

# The default value is false.

2936

},

2937

],

2938

"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) .

2943

# 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.

2944

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2945

},

2946

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2947

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2948

"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.

2949

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2950

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2951

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2952

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2953

# The value must be between 1 and 255 characters.

2954

"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.

2955

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2956

# The default is set to false.

2957

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2958

# 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.

2959

# The value must be between 1 and 1024 characters.

2960

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2961

# 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.

2962

# The value must be between 1 and 1024 characters.

2963

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2964

# Supported values are:

2965

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2966

# - FOUND, which corresponds to 302.

2967

# - SEE_OTHER which corresponds to 303.

2968

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2969

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2970

"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.

2971

# The default is set to false.

2972

},

2973

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2974

"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.

2975

#

2976

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2977

"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.

2978

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2979

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2980

{ # Specification determining how headers are added to requests or responses.

2981

"headerName": "A String", # The name of the header.

2982

"headerValue": "A String", # The value of the header to add.

2983

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2984

# The default value is false.

2985

},

2986

],

2987

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2988

"A String",

2989

],

2990

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2991

{ # Specification determining how headers are added to requests or responses.

2992

"headerName": "A String", # The name of the header.

2993

"headerValue": "A String", # The value of the header to add.

2994

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2995

# The default value is false.

2996

},

2997

],

2998

"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.

3003

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3004

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3005

"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 ..

3006

"A String",

3007

],

3008

"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.

3009

},

3010

],

3011

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3012

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3013

"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.

3014

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3015

{ # 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.

3016

"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.

3017

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3018

# 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]

3019

"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

3020

"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.

3021

# Default is false.

3022

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3023

"A String",

3024

],

3025

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3026

"A String",

3027

],

3028

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3029

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3030

"A String",

3031

],

3032

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3033

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3034

"A String",

3035

],

3036

"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.

3037

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3038

"A String",

3039

],

3040

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3041

},

3042

"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.

3043

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3044

"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.

3045

"httpStatus": 42, # The HTTP status code used to abort the request.

3046

# The value must be between 200 and 599 inclusive.

3047

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3048

# The value must be between 0.0 and 100.0 inclusive.

3049

},

3050

"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.

3051

"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.

3052

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3053

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3054

},

3055

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3056

# The value must be between 0.0 and 100.0 inclusive.

3057

},

3058

},

3059

"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.

3060

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3061

},

3062

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3063

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3064

"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.

3065

# 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.

3066

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3067

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3068

},

3069

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3070

# - 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.

3071

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3072

# -

3073

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3074

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3075

# - 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.

3076

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3077

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3078

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3079

# - 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.

3084

# If not specified, will use the largest timeout among all backend services associated with the route.

3085

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3086

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3087

},

3088

"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^]

3089

# 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]

3090

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3091

# The value must be between 1 and 255 characters.

3092

"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.

3093

# The value must be between 1 and 1024 characters.

3094

},

3095

"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.

3096

# 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.

3097

{ # 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

3098

"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.

3099

"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.

3100

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3101

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3102

{ # Specification determining how headers are added to requests or responses.

3103

"headerName": "A String", # The name of the header.

3104

"headerValue": "A String", # The value of the header to add.

3105

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3106

# The default value is false.

3107

},

3108

],

3109

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3110

"A String",

3111

],

3112

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3113

{ # Specification determining how headers are added to requests or responses.

3114

"headerName": "A String", # The name of the header.

3115

"headerValue": "A String", # The value of the header to add.

3116

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3117

# The default value is false.

3118

},

3119

],

3120

"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) .

3125

# 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.

3126

# 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:

3131

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3132

# - compute/v1/projects/project/global/backendServices/backendService

3133

# - 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.

3134

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3135

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3136

# - compute.backendBuckets.use

3137

# - compute.backendServices.use

3138

"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.

3139

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3140

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3141

# The value must be between 1 and 255 characters.

3142

"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.

3143

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3144

# The default is set to false.

3145

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3146

# 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.

3147

# The value must be between 1 and 1024 characters.

3148

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3149

# 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.

3150

# The value must be between 1 and 1024 characters.

3151

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3152

# Supported values are:

3153

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3154

# - FOUND, which corresponds to 302.

3155

# - SEE_OTHER which corresponds to 303.

3156

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3157

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3158

"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.

3159

# The default is set to false.

3160

},

3161

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3162

"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.

3163

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3164

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3165

{ # Specification determining how headers are added to requests or responses.

3166

"headerName": "A String", # The name of the header.

3167

"headerValue": "A String", # The value of the header to add.

3168

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3169

# The default value is false.

3170

},

3171

],

3172

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3173

"A String",

3174

],

3175

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3176

{ # Specification determining how headers are added to requests or responses.

3177

"headerName": "A String", # The name of the header.

3178

"headerValue": "A String", # The value of the header to add.

3179

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3180

# The default value is false.

3181

},

3182

],

3183

"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.

3188

"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.

3189

# 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.

3190

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3191

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3192

"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.

3193

"A String",

3194

],

3195

"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.

3196

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3197

# 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]

3198

"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

3199

"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.

3200

# Default is false.

3201

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3202

"A String",

3203

],

3204

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3205

"A String",

3206

],

3207

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3208

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3209

"A String",

3210

],

3211

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3212

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3213

"A String",

3214

],

3215

"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.

3216

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3217

"A String",

3218

],

3219

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3220

},

3221

"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.

3222

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3223

"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.

3224

"httpStatus": 42, # The HTTP status code used to abort the request.

3225

# The value must be between 200 and 599 inclusive.

3226

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3227

# The value must be between 0.0 and 100.0 inclusive.

3228

},

3229

"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.

3230

"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.

3231

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3232

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3233

},

3234

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3235

# The value must be between 0.0 and 100.0 inclusive.

3236

},

3237

},

3238

"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.

3239

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3240

},

3241

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3242

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3243

"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.

3244

# 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.

3245

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3246

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3247

},

3248

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3249

# - 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.

3250

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3251

# -

3252

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3253

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3254

# - 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.

3255

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3256

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3257

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3258

# - 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.

3263

# If not specified, will use the largest timeout among all backend services associated with the route.

3264

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3265

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3266

},

3267

"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^]

3268

# 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]

3269

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3270

# The value must be between 1 and 255 characters.

3271

"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.

3272

# The value must be between 1 and 1024 characters.

3273

},

3274

"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.

3275

# 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.

3276

{ # 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

3277

"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.

3278

"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.

3279

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3280

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3281

{ # Specification determining how headers are added to requests or responses.

3282

"headerName": "A String", # The name of the header.

3283

"headerValue": "A String", # The value of the header to add.

3284

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3285

# The default value is false.

3286

},

3287

],

3288

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3289

"A String",

3290

],

3291

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3292

{ # Specification determining how headers are added to requests or responses.

3293

"headerName": "A String", # The name of the header.

3294

"headerValue": "A String", # The value of the header to add.

3295

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3296

# The default value is false.

3297

},

3298

],

3299

"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) .

3304

# 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.

3305

# 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.

3310

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3311

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3312

# If urlRedirect is specified, service or routeAction must not be set.

3313

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3314

# The value must be between 1 and 255 characters.

3315

"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.

3316

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3317

# The default is set to false.

3318

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3319

# 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.

3320

# The value must be between 1 and 1024 characters.

3321

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3322

# 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.

3323

# The value must be between 1 and 1024 characters.

3324

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3325

# Supported values are:

3326

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3327

# - FOUND, which corresponds to 302.

3328

# - SEE_OTHER which corresponds to 303.

3329

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3330

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3331

"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.

3332

# 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.

3337

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3338

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3339

"description": "A String", # The short description conveying the intent of this routeRule.

3340

# The description can have a maximum length of 1024 characters.

3341

"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.

3342

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3343

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3344

{ # Specification determining how headers are added to requests or responses.

3345

"headerName": "A String", # The name of the header.

3346

"headerValue": "A String", # The value of the header to add.

3347

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3348

# The default value is false.

3349

},

3350

],

3351

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3352

"A String",

3353

],

3354

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3355

{ # Specification determining how headers are added to requests or responses.

3356

"headerName": "A String", # The name of the header.

3357

"headerValue": "A String", # The value of the header to add.

3358

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3359

# The default value is false.

3360

},

3361

],

3362

"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.

3368

"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.

3369

# fullPathMatch must be between 1 and 1024 characters.

3370

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3371

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3372

{ # matchRule criteria for request header matches.

3373

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3374

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3375

"headerName": "A String", # The name of the HTTP header to match.

3376

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3377

# For matching a request's method, use the headerName ":method".

3378

"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.

3379

# The default setting is false.

3380

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3381

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3382

"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.

3383

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3384

"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.

3385

# For example for a range [-5, 0]

3386

# - -3 will match.

3387

# - 0 will not match.

3388

# - 0.25 will not match.

3389

# - -3someString will not match.

3390

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3391

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3392

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3393

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3394

},

3395

"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

3396

# 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.

3397

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3398

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3399

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3400

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3401

},

3402

],

3403

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3404

# The default value is false.

3405

# ignoreCase must not be used with regexMatch.

3406

"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.

3407

# 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.

3408

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3409

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3410

{ # 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.

3411

# 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.

3412

# 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.

3413

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3414

# This list must not be empty and can have at the most 64 entries.

3415

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3416

"name": "A String", # Name of metadata label.

3417

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3418

"value": "A String", # The value of the label must match the specified value.

3419

# value can have a maximum length of 1024 characters.

3420

},

3421

],

3422

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3423

# Supported values are:

3424

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3425

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3426

},

3427

],

3428

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3429

# The value must be between 1 and 1024 characters.

3430

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3431

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3432

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3433

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3434

# Only one of presentMatch, exactMatch or regexMatch must be set.

3435

"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.

3436

"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.

3437

# Only one of presentMatch, exactMatch or regexMatch must be set.

3438

"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

3439

# Only one of presentMatch, exactMatch or regexMatch must be set.

3440

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3441

},

3442

],

3443

"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

3444

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3445

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3446

},

3447

],

3448

"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.

3449

# 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.

3450

# 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.

3451

"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.

3452

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3453

"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

3454

"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.

3455

# Default is false.

3456

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3457

"A String",

3458

],

3459

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3460

"A String",

3461

],

3462

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3463

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3464

"A String",

3465

],

3466

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3467

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3468

"A String",

3469

],

3470

"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.

3471

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3472

"A String",

3473

],

3474

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3475

},

3476

"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.

3477

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3478

"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.

3479

"httpStatus": 42, # The HTTP status code used to abort the request.

3480

# The value must be between 200 and 599 inclusive.

3481

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3482

# The value must be between 0.0 and 100.0 inclusive.

3483

},

3484

"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.

3485

"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.

3486

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3487

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3488

},

3489

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3490

# The value must be between 0.0 and 100.0 inclusive.

3491

},

3492

},

3493

"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.

3494

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3495

},

3496

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3497

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3498

"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.

3499

# 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.

3500

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3501

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3502

},

3503

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3504

# - 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.

3505

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3506

# -

3507

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3508

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3509

# - 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.

3510

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3511

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3512

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3513

# - 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.

3518

# If not specified, will use the largest timeout among all backend services associated with the route.

3519

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3520

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3521

},

3522

"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^]

3523

# 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]

3524

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3525

# The value must be between 1 and 255 characters.

3526

"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.

3527

# The value must be between 1 and 1024 characters.

3528

},

3529

"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.

3530

# 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.

3531

{ # 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

3532

"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.

3533

"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.

3534

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3535

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3536

{ # Specification determining how headers are added to requests or responses.

3537

"headerName": "A String", # The name of the header.

3538

"headerValue": "A String", # The value of the header to add.

3539

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3540

# The default value is false.

3541

},

3542

],

3543

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3544

"A String",

3545

],

3546

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3547

{ # Specification determining how headers are added to requests or responses.

3548

"headerName": "A String", # The name of the header.

3549

"headerValue": "A String", # The value of the header to add.

3550

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3551

# The default value is false.

3552

},

3553

],

3554

"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) .

3559

# 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.

3560

# 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.

3565

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3566

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3567

# If urlRedirect is specified, service or routeAction must not be set.

3568

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3569

# The value must be between 1 and 255 characters.

3570

"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.

3571

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3572

# The default is set to false.

3573

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3574

# 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.

3575

# The value must be between 1 and 1024 characters.

3576

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3577

# 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.

3578

# The value must be between 1 and 1024 characters.

3579

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3580

# Supported values are:

3581

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3582

# - FOUND, which corresponds to 302.

3583

# - SEE_OTHER which corresponds to 303.

3584

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3585

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3586

"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.

3587

# 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.

3594

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3595

"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.

3596

{ # Message for the expected URL mappings.

3597

"description": "A String", # Description of this test case.

3598

"host": "A String", # Host portion of the URL.

3599

"path": "A String", # Path portion of the URL.

3600

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

3601

},

3602

],

3603

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3604

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3605

"kind": "compute#urlMapList", # Type of resource.

3606

"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.

3607

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3608

"warning": { # [Output Only] Informational warning message.

3609

"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.

3610

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3611

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3612

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

"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).

3614

"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]

3615

},

3616

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3617

"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]

3618

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3624

<pre>Retrieves the next page of results.

3625

3626

Args:

3627

previous_request: The request for the previous page. (required)

3628

previous_response: The response from the request for the previous page. (required)

3629

3630

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3631

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3632

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]

3637

<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]

3638

<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.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3639

3640

Args:

3641

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

3642

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3643

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3644

The object takes the form of:

3645

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3646

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3647

#

3648

# Google Compute Engine has two URL Map resources:

3649

#

3650

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3651

#

3652

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3653

#

3654

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3655

#

3656

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3657

#

3658

# 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.

3659

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3660

"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.

3661

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3662

# 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]

3663

"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

3664

"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.

3665

# Default is false.

3666

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3667

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3668

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3669

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3670

"A String",

3671

],

3672

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3673

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3674

"A String",

3675

],

3676

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3677

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3678

"A String",

3679

],

3680

"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.

3681

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3682

"A String",

3683

],

3684

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3685

},

3686

"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.

3687

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3688

"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.

3689

"httpStatus": 42, # The HTTP status code used to abort the request.

3690

# The value must be between 200 and 599 inclusive.

3691

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3692

# The value must be between 0.0 and 100.0 inclusive.

3693

},

3694

"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.

3695

"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.

3696

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3697

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3698

},

3699

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3700

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3701

},

3702

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3703

"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.

3704

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3705

},

3706

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3707

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3708

"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.

3709

# 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.

3710

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3711

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3712

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3713

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3714

# - 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.

3715

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3716

# -

3717

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3718

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3719

# - 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.

3720

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3721

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3722

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3723

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3724

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3725

],

3726

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3727

"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.

3728

# If not specified, will use the largest timeout among all backend services associated with the route.

3729

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3730

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3731

},

3732

"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^]

3733

# 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]

3734

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3735

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3736

"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.

3737

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3738

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3739

"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.

3740

# 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.

3741

{ # 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

3742

"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.

3743

"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.

3744

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3745

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3746

{ # Specification determining how headers are added to requests or responses.

3747

"headerName": "A String", # The name of the header.

3748

"headerValue": "A String", # The value of the header to add.

3749

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3750

# The default value is false.

3751

},

3752

],

3753

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3754

"A String",

3755

],

3756

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3757

{ # Specification determining how headers are added to requests or responses.

3758

"headerName": "A String", # The name of the header.

3759

"headerValue": "A String", # The value of the header to add.

3760

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3761

# The default value is false.

3762

},

3763

],

3764

"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) .

3769

# 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.

3770

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3771

},

3772

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3773

},

3774

"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.

3775

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3776

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3777

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3778

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3779

# The value must be between 1 and 255 characters.

3780

"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.

3781

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3782

# The default is set to false.

3783

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3784

# 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.

3785

# The value must be between 1 and 1024 characters.

3786

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3787

# 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.

3788

# The value must be between 1 and 1024 characters.

3789

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3790

# Supported values are:

3791

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3792

# - FOUND, which corresponds to 302.

3793

# - SEE_OTHER which corresponds to 303.

3794

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3795

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3796

"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.

3797

# The default is set to false.

3798

},

3799

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3800

"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.

3801

#

3802

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3803

"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.

3804

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3805

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3806

{ # Specification determining how headers are added to requests or responses.

3807

"headerName": "A String", # The name of the header.

3808

"headerValue": "A String", # The value of the header to add.

3809

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3810

# The default value is false.

3811

},

3812

],

3813

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3814

"A String",

3815

],

3816

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3817

{ # Specification determining how headers are added to requests or responses.

3818

"headerName": "A String", # The name of the header.

3819

"headerValue": "A String", # The value of the header to add.

3820

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3821

# The default value is false.

3822

},

3823

],

3824

"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.

3829

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3830

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3831

"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 ..

3832

"A String",

3833

],

3834

"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.

3835

},

3836

],

3837

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3838

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3839

"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.

3840

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3841

{ # 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.

3842

"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.

3843

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

3844

# 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]

3845

"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

3846

"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.

3847

# Default is false.

3848

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3849

"A String",

3850

],

3851

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3852

"A String",

3853

],

3854

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3855

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3856

"A String",

3857

],

3858

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3859

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3860

"A String",

3861

],

3862

"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.

3863

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3864

"A String",

3865

],

3866

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3867

},

3868

"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.

3869

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3870

"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.

3871

"httpStatus": 42, # The HTTP status code used to abort the request.

3872

# The value must be between 200 and 599 inclusive.

3873

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3874

# The value must be between 0.0 and 100.0 inclusive.

3875

},

3876

"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.

3877

"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.

3878

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3879

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3880

},

3881

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3882

# The value must be between 0.0 and 100.0 inclusive.

3883

},

3884

},

3885

"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.

3886

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3887

},

3888

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3889

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3890

"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.

3891

# 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.

3892

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3893

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3894

},

3895

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3896

# - 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.

3897

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3898

# -

3899

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3900

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3901

# - 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.

3902

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3903

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3904

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3905

# - 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.

3910

# If not specified, will use the largest timeout among all backend services associated with the route.

3911

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3912

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3913

},

3914

"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^]

3915

# 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]

3916

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3917

# The value must be between 1 and 255 characters.

3918

"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.

3919

# The value must be between 1 and 1024 characters.

3920

},

3921

"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.

3922

# 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.

3923

{ # 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

3924

"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.

3925

"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.

3926

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3927

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3928

{ # Specification determining how headers are added to requests or responses.

3929

"headerName": "A String", # The name of the header.

3930

"headerValue": "A String", # The value of the header to add.

3931

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3932

# The default value is false.

3933

},

3934

],

3935

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3936

"A String",

3937

],

3938

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3939

{ # Specification determining how headers are added to requests or responses.

3940

"headerName": "A String", # The name of the header.

3941

"headerValue": "A String", # The value of the header to add.

3942

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3943

# The default value is false.

3944

},

3945

],

3946

"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) .

3951

# 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.

3952

# 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:

3957

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3958

# - compute/v1/projects/project/global/backendServices/backendService

3959

# - 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.

3960

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3961

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3962

# - compute.backendBuckets.use

3963

# - compute.backendServices.use

3964

"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.

3965

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3966

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3967

# The value must be between 1 and 255 characters.

3968

"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.

3969

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3970

# The default is set to false.

3971

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3972

# 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.

3973

# The value must be between 1 and 1024 characters.

3974

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3975

# 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.

3976

# The value must be between 1 and 1024 characters.

3977

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3978

# Supported values are:

3979

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3980

# - FOUND, which corresponds to 302.

3981

# - SEE_OTHER which corresponds to 303.

3982

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3983

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3984

"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.

3985

# The default is set to false.

3986

},

3987

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3988

"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.

3989

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3990

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3991

{ # Specification determining how headers are added to requests or responses.

3992

"headerName": "A String", # The name of the header.

3993

"headerValue": "A String", # The value of the header to add.

3994

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3995

# The default value is false.

3996

},

3997

],

3998

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3999

"A String",

4000

],

4001

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4002

{ # Specification determining how headers are added to requests or responses.

4003

"headerName": "A String", # The name of the header.

4004

"headerValue": "A String", # The value of the header to add.

4005

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4006

# The default value is false.

4007

},

4008

],

4009

"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.

4014

"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.

4015

# 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.

4016

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4017

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4018

"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.

4019

"A String",

4020

],

4021

"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.

4022

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4023

# 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]

4024

"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

4025

"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.

4026

# Default is false.

4027

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4028

"A String",

4029

],

4030

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4031

"A String",

4032

],

4033

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4034

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4035

"A String",

4036

],

4037

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4038

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4039

"A String",

4040

],

4041

"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.

4042

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4043

"A String",

4044

],

4045

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4046

},

4047

"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.

4048

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4049

"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.

4050

"httpStatus": 42, # The HTTP status code used to abort the request.

4051

# The value must be between 200 and 599 inclusive.

4052

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4053

# The value must be between 0.0 and 100.0 inclusive.

4054

},

4055

"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.

4056

"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.

4057

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4058

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4059

},

4060

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4061

# The value must be between 0.0 and 100.0 inclusive.

4062

},

4063

},

4064

"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.

4065

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4066

},

4067

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4068

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4069

"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.

4070

# 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.

4071

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4072

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4073

},

4074

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4075

# - 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.

4076

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4077

# -

4078

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4079

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4080

# - 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.

4081

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4082

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4083

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4084

# - 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.

4089

# If not specified, will use the largest timeout among all backend services associated with the route.

4090

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4091

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4092

},

4093

"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^]

4094

# 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]

4095

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4096

# The value must be between 1 and 255 characters.

4097

"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.

4098

# The value must be between 1 and 1024 characters.

4099

},

4100

"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.

4101

# 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.

4102

{ # 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

4103

"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.

4104

"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.

4105

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4106

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4107

{ # Specification determining how headers are added to requests or responses.

4108

"headerName": "A String", # The name of the header.

4109

"headerValue": "A String", # The value of the header to add.

4110

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4111

# The default value is false.

4112

},

4113

],

4114

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4115

"A String",

4116

],

4117

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4118

{ # Specification determining how headers are added to requests or responses.

4119

"headerName": "A String", # The name of the header.

4120

"headerValue": "A String", # The value of the header to add.

4121

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4122

# The default value is false.

4123

},

4124

],

4125

"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) .

4130

# 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.

4131

# 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.

4136

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4137

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4138

# If urlRedirect is specified, service or routeAction must not be set.

4139

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4140

# The value must be between 1 and 255 characters.

4141

"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.

4142

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4143

# The default is set to false.

4144

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4145

# 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.

4146

# The value must be between 1 and 1024 characters.

4147

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4148

# 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.

4149

# The value must be between 1 and 1024 characters.

4150

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4151

# Supported values are:

4152

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4153

# - FOUND, which corresponds to 302.

4154

# - SEE_OTHER which corresponds to 303.

4155

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4156

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4157

"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.

4158

# 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.

4163

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4164

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4165

"description": "A String", # The short description conveying the intent of this routeRule.

4166

# The description can have a maximum length of 1024 characters.

4167

"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.

4168

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4169

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4170

{ # Specification determining how headers are added to requests or responses.

4171

"headerName": "A String", # The name of the header.

4172

"headerValue": "A String", # The value of the header to add.

4173

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4174

# The default value is false.

4175

},

4176

],

4177

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4178

"A String",

4179

],

4180

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4181

{ # Specification determining how headers are added to requests or responses.

4182

"headerName": "A String", # The name of the header.

4183

"headerValue": "A String", # The value of the header to add.

4184

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4185

# The default value is false.

4186

},

4187

],

4188

"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.

4194

"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.

4195

# fullPathMatch must be between 1 and 1024 characters.

4196

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4197

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4198

{ # matchRule criteria for request header matches.

4199

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4200

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4201

"headerName": "A String", # The name of the HTTP header to match.

4202

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4203

# For matching a request's method, use the headerName ":method".

4204

"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.

4205

# The default setting is false.

4206

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4207

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4208

"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.

4209

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4210

"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.

4211

# For example for a range [-5, 0]

4212

# - -3 will match.

4213

# - 0 will not match.

4214

# - 0.25 will not match.

4215

# - -3someString will not match.

4216

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4217

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4218

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4219

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4220

},

4221

"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

4222

# 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.

4223

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4224

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4225

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4226

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4227

},

4228

],

4229

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4230

# The default value is false.

4231

# ignoreCase must not be used with regexMatch.

4232

"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.

4233

# 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.

4234

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4235

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4236

{ # 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.

4237

# 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.

4238

# 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.

4239

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4240

# This list must not be empty and can have at the most 64 entries.

4241

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4242

"name": "A String", # Name of metadata label.

4243

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4244

"value": "A String", # The value of the label must match the specified value.

4245

# value can have a maximum length of 1024 characters.

4246

},

4247

],

4248

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4249

# Supported values are:

4250

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4251

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4252

},

4253

],

4254

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4255

# The value must be between 1 and 1024 characters.

4256

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4257

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4258

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4259

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4260

# Only one of presentMatch, exactMatch or regexMatch must be set.

4261

"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.

4262

"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.

4263

# Only one of presentMatch, exactMatch or regexMatch must be set.

4264

"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

4265

# Only one of presentMatch, exactMatch or regexMatch must be set.

4266

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4267

},

4268

],

4269

"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

4270

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4271

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4272

},

4273

],

4274

"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.

4275

# 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.

4276

# 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.

4277

"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.

4278

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4279

"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

4280

"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.

4281

# Default is false.

4282

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4283

"A String",

4284

],

4285

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4286

"A String",

4287

],

4288

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4289

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4290

"A String",

4291

],

4292

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4293

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4294

"A String",

4295

],

4296

"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.

4297

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4298

"A String",

4299

],

4300

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4301

},

4302

"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.

4303

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4304

"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.

4305

"httpStatus": 42, # The HTTP status code used to abort the request.

4306

# The value must be between 200 and 599 inclusive.

4307

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4308

# The value must be between 0.0 and 100.0 inclusive.

4309

},

4310

"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.

4311

"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.

4312

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4313

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4314

},

4315

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4316

# The value must be between 0.0 and 100.0 inclusive.

4317

},

4318

},

4319

"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.

4320

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4321

},

4322

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4323

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4324

"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.

4325

# 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.

4326

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4327

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4328

},

4329

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4330

# - 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.

4331

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4332

# -

4333

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4334

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4335

# - 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.

4336

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4337

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4338

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4339

# - 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.

4344

# If not specified, will use the largest timeout among all backend services associated with the route.

4345

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4346

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4347

},

4348

"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^]

4349

# 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]

4350

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4351

# The value must be between 1 and 255 characters.

4352

"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.

4353

# The value must be between 1 and 1024 characters.

4354

},

4355

"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.

4356

# 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.

4357

{ # 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

4358

"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.

4359

"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.

4360

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4361

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4362

{ # Specification determining how headers are added to requests or responses.

4363

"headerName": "A String", # The name of the header.

4364

"headerValue": "A String", # The value of the header to add.

4365

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4366

# The default value is false.

4367

},

4368

],

4369

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4370

"A String",

4371

],

4372

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4373

{ # Specification determining how headers are added to requests or responses.

4374

"headerName": "A String", # The name of the header.

4375

"headerValue": "A String", # The value of the header to add.

4376

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4377

# The default value is false.

4378

},

4379

],

4380

"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) .

4385

# 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.

4386

# 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.

4391

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4392

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4393

# If urlRedirect is specified, service or routeAction must not be set.

4394

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4395

# The value must be between 1 and 255 characters.

4396

"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.

4397

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4398

# The default is set to false.

4399

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4400

# 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.

4401

# The value must be between 1 and 1024 characters.

4402

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4403

# 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.

4404

# The value must be between 1 and 1024 characters.

4405

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4406

# Supported values are:

4407

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4408

# - FOUND, which corresponds to 302.

4409

# - SEE_OTHER which corresponds to 303.

4410

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4411

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4412

"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.

4413

# 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.

4420

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4421

"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.

4422

{ # Message for the expected URL mappings.

4423

"description": "A String", # Description of this test case.

4424

"host": "A String", # Host portion of the URL.

4425

"path": "A String", # Path portion of the URL.

4426

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

4427

},

4428

],

4429

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4430

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4431

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.

4432

4433

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.

4434

4435

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4436

4437

Returns:

4438

An object of the form:

4439

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4440

{ # Represents an Operation resource.

4441

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4442

# Google Compute Engine has three Operation resources:

4443

#

4444

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4445

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4446

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4447

#

4448

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4449

# - For global operations, use the `globalOperations` resource.

4450

# - For regional operations, use the `regionOperations` resource.

4451

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4452

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4453

# 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]

4454

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4455

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4456

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4457

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4458

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4459

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4460

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4461

"code": "A String", # [Output Only] The error type identifier for this error.

4462

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4463

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4464

},

4465

],

4466

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4467

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4468

"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.

4469

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4470

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4471

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4472

"name": "A String", # [Output Only] Name of the operation.

4473

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4474

"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.

4475

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4476

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4477

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4478

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4479

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4480

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4481

"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.

4482

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4483

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4484

{

4485

"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.

4486

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4487

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4488

{

4489

"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).

4490

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4491

},

4492

],

4493

"message": "A String", # [Output Only] A human-readable description of the warning code.

4494

},

4495

],

4496

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4501

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4502

<pre>Returns permissions that a caller has on the specified resource.

4503

4504

Args:

4505

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4506

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4507

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4508

The object takes the form of:

4509

4510

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4511

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

4512

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

4519

4520

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4521

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

4522

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4528

<code class="details" id="update">update(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4529

<pre>Updates the specified UrlMap resource with the data included in the request.

4530

4531

Args:

4532

project: string, Project ID for this request. (required)

4533

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4534

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4535

The object takes the form of:

4536

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4537

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4538

#

4539

# Google Compute Engine has two URL Map resources:

4540

#

4541

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4542

#

4543

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4544

#

4545

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4546

#

4547

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4548

#

4549

# 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.

4550

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4551

"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.

4552

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4553

# 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]

4554

"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

4555

"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.

4556

# Default is false.

4557

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4558

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4559

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4560

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4561

"A String",

4562

],

4563

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4564

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4565

"A String",

4566

],

4567

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4568

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4569

"A String",

4570

],

4571

"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.

4572

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4573

"A String",

4574

],

4575

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4576

},

4577

"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.

4578

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4579

"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.

4580

"httpStatus": 42, # The HTTP status code used to abort the request.

4581

# The value must be between 200 and 599 inclusive.

4582

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4583

# The value must be between 0.0 and 100.0 inclusive.

4584

},

4585

"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.

4586

"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.

4587

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4588

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4589

},

4590

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4591

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4592

},

4593

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4594

"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.

4595

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4596

},

4597

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4598

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4599

"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.

4600

# 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.

4601

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4602

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4603

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4604

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4605

# - 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.

4606

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4607

# -

4608

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4609

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4610

# - 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.

4611

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4612

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4613

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4614

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4615

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4616

],

4617

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4618

"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.

4619

# If not specified, will use the largest timeout among all backend services associated with the route.

4620

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4621

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4622

},

4623

"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^]

4624

# 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]

4625

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4626

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4627

"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.

4628

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4629

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4630

"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.

4631

# 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.

4632

{ # 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

4633

"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.

4634

"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.

4635

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4636

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4637

{ # Specification determining how headers are added to requests or responses.

4638

"headerName": "A String", # The name of the header.

4639

"headerValue": "A String", # The value of the header to add.

4640

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4641

# The default value is false.

4642

},

4643

],

4644

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4645

"A String",

4646

],

4647

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4648

{ # Specification determining how headers are added to requests or responses.

4649

"headerName": "A String", # The name of the header.

4650

"headerValue": "A String", # The value of the header to add.

4651

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4652

# The default value is false.

4653

},

4654

],

4655

"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) .

4660

# 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.

4661

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4662

},

4663

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4664

},

4665

"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.

4666

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4667

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4668

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4669

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4670

# The value must be between 1 and 255 characters.

4671

"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.

4672

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4673

# The default is set to false.

4674

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4675

# 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.

4676

# The value must be between 1 and 1024 characters.

4677

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4678

# 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.

4679

# The value must be between 1 and 1024 characters.

4680

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4681

# Supported values are:

4682

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4683

# - FOUND, which corresponds to 302.

4684

# - SEE_OTHER which corresponds to 303.

4685

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4686

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4687

"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.

4688

# The default is set to false.

4689

},

4690

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4691

"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.

4692

#

4693

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4694

"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.

4695

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4696

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4697

{ # Specification determining how headers are added to requests or responses.

4698

"headerName": "A String", # The name of the header.

4699

"headerValue": "A String", # The value of the header to add.

4700

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4701

# The default value is false.

4702

},

4703

],

4704

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4705

"A String",

4706

],

4707

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4708

{ # Specification determining how headers are added to requests or responses.

4709

"headerName": "A String", # The name of the header.

4710

"headerValue": "A String", # The value of the header to add.

4711

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4712

# The default value is false.

4713

},

4714

],

4715

"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.

4720

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4721

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4722

"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 ..

4723

"A String",

4724

],

4725

"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.

4726

},

4727

],

4728

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4729

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4730

"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.

4731

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4732

{ # 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.

4733

"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.

4734

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4735

# 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]

4736

"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

4737

"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.

4738

# Default is false.

4739

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4740

"A String",

4741

],

4742

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4743

"A String",

4744

],

4745

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4746

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4747

"A String",

4748

],

4749

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4750

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4751

"A String",

4752

],

4753

"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.

4754

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4755

"A String",

4756

],

4757

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4758

},

4759

"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.

4760

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4761

"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.

4762

"httpStatus": 42, # The HTTP status code used to abort the request.

4763

# The value must be between 200 and 599 inclusive.

4764

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4765

# The value must be between 0.0 and 100.0 inclusive.

4766

},

4767

"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.

4768

"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.

4769

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4770

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4771

},

4772

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4773

# The value must be between 0.0 and 100.0 inclusive.

4774

},

4775

},

4776

"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.

4777

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4778

},

4779

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4780

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4781

"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.

4782

# 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.

4783

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4784

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4785

},

4786

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4787

# - 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.

4788

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4789

# -

4790

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4791

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4792

# - 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.

4793

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4794

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4795

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4796

# - 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.

4801

# If not specified, will use the largest timeout among all backend services associated with the route.

4802

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4803

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4804

},

4805

"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^]

4806

# 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]

4807

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4808

# The value must be between 1 and 255 characters.

4809

"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.

4810

# The value must be between 1 and 1024 characters.

4811

},

4812

"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.

4813

# 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.

4814

{ # 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

4815

"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.

4816

"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.

4817

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4818

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4819

{ # Specification determining how headers are added to requests or responses.

4820

"headerName": "A String", # The name of the header.

4821

"headerValue": "A String", # The value of the header to add.

4822

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4823

# The default value is false.

4824

},

4825

],

4826

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4827

"A String",

4828

],

4829

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4830

{ # Specification determining how headers are added to requests or responses.

4831

"headerName": "A String", # The name of the header.

4832

"headerValue": "A String", # The value of the header to add.

4833

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4834

# The default value is false.

4835

},

4836

],

4837

"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) .

4842

# 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.

4843

# 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:

4848

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4849

# - compute/v1/projects/project/global/backendServices/backendService

4850

# - 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.

4851

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4852

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4853

# - compute.backendBuckets.use

4854

# - compute.backendServices.use

4855

"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.

4856

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4857

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4858

# The value must be between 1 and 255 characters.

4859

"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.

4860

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4861

# The default is set to false.

4862

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4863

# 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.

4864

# The value must be between 1 and 1024 characters.

4865

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4866

# 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.

4867

# The value must be between 1 and 1024 characters.

4868

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4869

# Supported values are:

4870

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4871

# - FOUND, which corresponds to 302.

4872

# - SEE_OTHER which corresponds to 303.

4873

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4874

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4875

"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.

4876

# The default is set to false.

4877

},

4878

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4879

"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.

4880

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4881

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4882

{ # Specification determining how headers are added to requests or responses.

4883

"headerName": "A String", # The name of the header.

4884

"headerValue": "A String", # The value of the header to add.

4885

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4886

# The default value is false.

4887

},

4888

],

4889

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4890

"A String",

4891

],

4892

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4893

{ # Specification determining how headers are added to requests or responses.

4894

"headerName": "A String", # The name of the header.

4895

"headerValue": "A String", # The value of the header to add.

4896

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4897

# The default value is false.

4898

},

4899

],

4900

"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.

4905

"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.

4906

# 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.

4907

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4908

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4909

"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.

4910

"A String",

4911

],

4912

"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.

4913

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

4914

# 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]

4915

"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

4916

"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.

4917

# Default is false.

4918

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4919

"A String",

4920

],

4921

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4922

"A String",

4923

],

4924

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4925

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4926

"A String",

4927

],

4928

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4929

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4930

"A String",

4931

],

4932

"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.

4933

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4934

"A String",

4935

],

4936

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4937

},

4938

"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.

4939

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4940

"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.

4941

"httpStatus": 42, # The HTTP status code used to abort the request.

4942

# The value must be between 200 and 599 inclusive.

4943

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4944

# The value must be between 0.0 and 100.0 inclusive.

4945

},

4946

"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.

4947

"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.

4948

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4949

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4950

},

4951

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4952

# The value must be between 0.0 and 100.0 inclusive.

4953

},

4954

},

4955

"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.

4956

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4957

},

4958

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4959

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4960

"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.

4961

# 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.

4962

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4963

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4964

},

4965

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4966

# - 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.

4967

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4968

# -

4969

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4970

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4971

# - 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.

4972

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4973

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4974

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4975

# - 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.

4980

# If not specified, will use the largest timeout among all backend services associated with the route.

4981

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4982

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4983

},

4984

"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^]

4985

# 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]

4986

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4987

# The value must be between 1 and 255 characters.

4988

"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.

4989

# The value must be between 1 and 1024 characters.

4990

},

4991

"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.

4992

# 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.

4993

{ # 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

4994

"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.

4995

"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.

4996

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4997

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4998

{ # Specification determining how headers are added to requests or responses.

4999

"headerName": "A String", # The name of the header.

5000

"headerValue": "A String", # The value of the header to add.

5001

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5002

# The default value is false.

5003

},

5004

],

5005

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5006

"A String",

5007

],

5008

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5009

{ # Specification determining how headers are added to requests or responses.

5010

"headerName": "A String", # The name of the header.

5011

"headerValue": "A String", # The value of the header to add.

5012

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5013

# The default value is false.

5014

},

5015

],

5016

"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) .

5021

# 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.

5022

# 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.

5027

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5028

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5029

# If urlRedirect is specified, service or routeAction must not be set.

5030

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5031

# The value must be between 1 and 255 characters.

5032

"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.

5033

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5034

# The default is set to false.

5035

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5036

# 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.

5037

# The value must be between 1 and 1024 characters.

5038

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5039

# 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.

5040

# The value must be between 1 and 1024 characters.

5041

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5042

# Supported values are:

5043

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5044

# - FOUND, which corresponds to 302.

5045

# - SEE_OTHER which corresponds to 303.

5046

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5047

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5048

"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.

5049

# 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.

5054

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5055

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5056

"description": "A String", # The short description conveying the intent of this routeRule.

5057

# The description can have a maximum length of 1024 characters.

5058

"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.

5059

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5060

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5061

{ # Specification determining how headers are added to requests or responses.

5062

"headerName": "A String", # The name of the header.

5063

"headerValue": "A String", # The value of the header to add.

5064

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5065

# The default value is false.

5066

},

5067

],

5068

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5069

"A String",

5070

],

5071

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5072

{ # Specification determining how headers are added to requests or responses.

5073

"headerName": "A String", # The name of the header.

5074

"headerValue": "A String", # The value of the header to add.

5075

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5076

# The default value is false.

5077

},

5078

],

5079

"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.

5085

"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.

5086

# fullPathMatch must be between 1 and 1024 characters.

5087

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5088

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5089

{ # matchRule criteria for request header matches.

5090

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5091

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5092

"headerName": "A String", # The name of the HTTP header to match.

5093

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5094

# For matching a request's method, use the headerName ":method".

5095

"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.

5096

# The default setting is false.

5097

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5098

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5099

"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.

5100

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5101

"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.

5102

# For example for a range [-5, 0]

5103

# - -3 will match.

5104

# - 0 will not match.

5105

# - 0.25 will not match.

5106

# - -3someString will not match.

5107

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5108

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5109

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5110

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5111

},

5112

"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

5113

# 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.

5114

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5115

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5116

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5117

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5118

},

5119

],

5120

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5121

# The default value is false.

5122

# ignoreCase must not be used with regexMatch.

5123

"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.

5124

# 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.

5125

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5126

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5127

{ # 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.

5128

# 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.

5129

# 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.

5130

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5131

# This list must not be empty and can have at the most 64 entries.

5132

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5133

"name": "A String", # Name of metadata label.

5134

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5135

"value": "A String", # The value of the label must match the specified value.

5136

# value can have a maximum length of 1024 characters.

5137

},

5138

],

5139

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5140

# Supported values are:

5141

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5142

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5143

},

5144

],

5145

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5146

# The value must be between 1 and 1024 characters.

5147

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5148

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5149

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5150

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5151

# Only one of presentMatch, exactMatch or regexMatch must be set.

5152

"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.

5153

"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.

5154

# Only one of presentMatch, exactMatch or regexMatch must be set.

5155

"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

5156

# Only one of presentMatch, exactMatch or regexMatch must be set.

5157

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5158

},

5159

],

5160

"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

5161

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5162

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5163

},

5164

],

5165

"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.

5166

# 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.

5167

# 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.

5168

"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.

5169

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5170

"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

5171

"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.

5172

# Default is false.

5173

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5174

"A String",

5175

],

5176

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5177

"A String",

5178

],

5179

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5180

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5181

"A String",

5182

],

5183

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5184

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5185

"A String",

5186

],

5187

"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.

5188

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5189

"A String",

5190

],

5191

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5192

},

5193

"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.

5194

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5195

"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.

5196

"httpStatus": 42, # The HTTP status code used to abort the request.

5197

# The value must be between 200 and 599 inclusive.

5198

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5199

# The value must be between 0.0 and 100.0 inclusive.

5200

},

5201

"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.

5202

"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.

5203

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5204

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5205

},

5206

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5207

# The value must be between 0.0 and 100.0 inclusive.

5208

},

5209

},

5210

"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.

5211

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5212

},

5213

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5214

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5215

"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.

5216

# 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.

5217

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5218

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5219

},

5220

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5221

# - 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.

5222

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5223

# -

5224

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5225

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5226

# - 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.

5227

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5228

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5229

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5230

# - 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.

5235

# If not specified, will use the largest timeout among all backend services associated with the route.

5236

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5237

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5238

},

5239

"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^]

5240

# 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]

5241

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5242

# The value must be between 1 and 255 characters.

5243

"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.

5244

# The value must be between 1 and 1024 characters.

5245

},

5246

"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.

5247

# 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.

5248

{ # 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

5249

"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.

5250

"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.

5251

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5252

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5253

{ # Specification determining how headers are added to requests or responses.

5254

"headerName": "A String", # The name of the header.

5255

"headerValue": "A String", # The value of the header to add.

5256

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5257

# The default value is false.

5258

},

5259

],

5260

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5261

"A String",

5262

],

5263

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5264

{ # Specification determining how headers are added to requests or responses.

5265

"headerName": "A String", # The name of the header.

5266

"headerValue": "A String", # The value of the header to add.

5267

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5268

# The default value is false.

5269

},

5270

],

5271

"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) .

5276

# 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.

5277

# 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.

5282

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5283

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5284

# If urlRedirect is specified, service or routeAction must not be set.

5285

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5286

# The value must be between 1 and 255 characters.

5287

"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.

5288

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5289

# The default is set to false.

5290

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5291

# 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.

5292

# The value must be between 1 and 1024 characters.

5293

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5294

# 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.

5295

# The value must be between 1 and 1024 characters.

5296

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5297

# Supported values are:

5298

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5299

# - FOUND, which corresponds to 302.

5300

# - SEE_OTHER which corresponds to 303.

5301

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5302

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5303

"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.

5304

# 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.

5311

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5312

"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.

5313

{ # Message for the expected URL mappings.

5314

"description": "A String", # Description of this test case.

5315

"host": "A String", # Host portion of the URL.

5316

"path": "A String", # Path portion of the URL.

5317

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

5318

},

5319

],

5320

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5321

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5322

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.

5323

5324

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.

5325

5326

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5327

5328

Returns:

5329

An object of the form:

5330

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5331

{ # Represents an Operation resource.

5332

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5333

# Google Compute Engine has three Operation resources:

5334

#

5335

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5336

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5337

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5338

#

5339

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5340

# - For global operations, use the `globalOperations` resource.

5341

# - For regional operations, use the `regionOperations` resource.

5342

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5343

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5344

# 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]

5345

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5346

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5347

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5348

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5349

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5350

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5351

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5352

"code": "A String", # [Output Only] The error type identifier for this error.

5353

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5354

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5355

},

5356

],

5357

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5358

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5359

"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.

5360

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5361

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5362

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5363

"name": "A String", # [Output Only] Name of the operation.

5364

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5365

"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.

5366

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5367

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5368

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5369

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5370

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5371

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5372

"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.

5373

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5374

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5375

{

5376

"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.

5377

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5378

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5379

{

5380

"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).

5381

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5382

},

5383

],

5384

"message": "A String", # [Output Only] A human-readable description of the warning code.

5385

},

5386

],

5387

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5392

<code class="details" id="validate">validate(project, urlMap, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5393

<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.

5394

5395

Args:

5396

project: string, Project ID for this request. (required)

5397

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5398

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5399

The object takes the form of:

5400

5401

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5402

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

5403

#

5404

# Google Compute Engine has two URL Map resources:

5405

#

5406

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

5407

#

5408

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

5409

#

5410

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

5411

#

5412

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

5413

#

5414

# 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.

5415

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5416

"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.

5417

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5418

# 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]

5419

"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

5420

"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.

5421

# Default is false.

5422

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5423

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5424

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5425

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5426

"A String",

5427

],

5428

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5429

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5430

"A String",

5431

],

5432

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5433

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5434

"A String",

5435

],

5436

"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.

5437

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5438

"A String",

5439

],

5440

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5441

},

5442

"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.

5443

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5444

"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.

5445

"httpStatus": 42, # The HTTP status code used to abort the request.

5446

# The value must be between 200 and 599 inclusive.

5447

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5448

# The value must be between 0.0 and 100.0 inclusive.

5449

},

5450

"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.

5451

"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.

5452

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5453

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5454

},

5455

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5456

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5457

},

5458

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5459

"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.

5460

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5461

},

5462

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5463

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5464

"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.

5465

# 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.

5466

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5467

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5468

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5469

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5470

# - 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.

5471

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5472

# -

5473

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5474

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5475

# - 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.

5476

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5477

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5478

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5479

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5480

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5481

],

5482

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5483

"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.

5484

# If not specified, will use the largest timeout among all backend services associated with the route.

5485

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5486

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5487

},

5488

"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^]

5489

# 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]

5490

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5491

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5492

"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.

5493

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5494

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5495

"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.

5496

# 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.

5497

{ # 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

5498

"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.

5499

"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.

5500

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5501

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5502

{ # Specification determining how headers are added to requests or responses.

5503

"headerName": "A String", # The name of the header.

5504

"headerValue": "A String", # The value of the header to add.

5505

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5506

# The default value is false.

5507

},

5508

],

5509

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5510

"A String",

5511

],

5512

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5513

{ # Specification determining how headers are added to requests or responses.

5514

"headerName": "A String", # The name of the header.

5515

"headerValue": "A String", # The value of the header to add.

5516

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5517

# The default value is false.

5518

},

5519

],

5520

"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) .

5525

# 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.

5526

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5527

},

5528

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5529

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5530

"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.

5531

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5532

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5533

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5534

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5535

# The value must be between 1 and 255 characters.

5536

"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.

5537

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5538

# The default is set to false.

5539

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5540

# 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.

5541

# The value must be between 1 and 1024 characters.

5542

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5543

# 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.

5544

# The value must be between 1 and 1024 characters.

5545

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5546

# Supported values are:

5547

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5548

# - FOUND, which corresponds to 302.

5549

# - SEE_OTHER which corresponds to 303.

5550

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5551

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5552

"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.

5553

# The default is set to false.

5554

},

5555

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5556

"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.

5557

#

5558

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

5559

"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.

5560

# The headerAction specified here take effect after headerAction specified under pathMatcher.

5561

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5562

{ # Specification determining how headers are added to requests or responses.

5563

"headerName": "A String", # The name of the header.

5564

"headerValue": "A String", # The value of the header to add.

5565

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5566

# The default value is false.

5567

},

5568

],

5569

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5570

"A String",

5571

],

5572

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5573

{ # Specification determining how headers are added to requests or responses.

5574

"headerName": "A String", # The name of the header.

5575

"headerValue": "A String", # The value of the header to add.

5576

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5577

# The default value is false.

5578

},

5579

],

5580

"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.

5585

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5586

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5587

"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 ..

5588

"A String",

5589

],

5590

"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.

5591

},

5592

],

5593

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5594

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5595

"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.

5596

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5597

{ # 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.

5598

"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.

5599

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5600

# 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]

5601

"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

5602

"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.

5603

# Default is false.

5604

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5605

"A String",

5606

],

5607

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5608

"A String",

5609

],

5610

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5611

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5612

"A String",

5613

],

5614

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5615

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5616

"A String",

5617

],

5618

"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.

5619

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5620

"A String",

5621

],

5622

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5623

},

5624

"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.

5625

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5626

"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.

5627

"httpStatus": 42, # The HTTP status code used to abort the request.

5628

# The value must be between 200 and 599 inclusive.

5629

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5630

# The value must be between 0.0 and 100.0 inclusive.

5631

},

5632

"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.

5633

"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.

5634

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5635

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5636

},

5637

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5638

# The value must be between 0.0 and 100.0 inclusive.

5639

},

5640

},

5641

"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.

5642

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5643

},

5644

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5645

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5646

"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.

5647

# 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.

5648

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5649

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5650

},

5651

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5652

# - 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.

5653

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5654

# -

5655

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5656

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5657

# - 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.

5658

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5659

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5660

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5661

# - 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.

5666

# If not specified, will use the largest timeout among all backend services associated with the route.

5667

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5668

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5669

},

5670

"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^]

5671

# 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]

5672

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5673

# The value must be between 1 and 255 characters.

5674

"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.

5675

# The value must be between 1 and 1024 characters.

5676

},

5677

"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.

5678

# 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.

5679

{ # 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

5680

"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.

5681

"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.

5682

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5683

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5684

{ # Specification determining how headers are added to requests or responses.

5685

"headerName": "A String", # The name of the header.

5686

"headerValue": "A String", # The value of the header to add.

5687

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5688

# The default value is false.

5689

},

5690

],

5691

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5692

"A String",

5693

],

5694

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5695

{ # Specification determining how headers are added to requests or responses.

5696

"headerName": "A String", # The name of the header.

5697

"headerValue": "A String", # The value of the header to add.

5698

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5699

# The default value is false.

5700

},

5701

],

5702

"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) .

5707

# 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.

5708

# 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:

5713

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

5714

# - compute/v1/projects/project/global/backendServices/backendService

5715

# - 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.

5716

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5717

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

5718

# - compute.backendBuckets.use

5719

# - compute.backendServices.use

5720

"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.

5721

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5722

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5723

# The value must be between 1 and 255 characters.

5724

"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.

5725

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5726

# The default is set to false.

5727

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5728

# 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.

5729

# The value must be between 1 and 1024 characters.

5730

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5731

# 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.

5732

# The value must be between 1 and 1024 characters.

5733

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5734

# Supported values are:

5735

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5736

# - FOUND, which corresponds to 302.

5737

# - SEE_OTHER which corresponds to 303.

5738

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5739

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5740

"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.

5741

# The default is set to false.

5742

},

5743

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5744

"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.

5745

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

5746

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5747

{ # Specification determining how headers are added to requests or responses.

5748

"headerName": "A String", # The name of the header.

5749

"headerValue": "A String", # The value of the header to add.

5750

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5751

# The default value is false.

5752

},

5753

],

5754

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5755

"A String",

5756

],

5757

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5758

{ # Specification determining how headers are added to requests or responses.

5759

"headerName": "A String", # The name of the header.

5760

"headerValue": "A String", # The value of the header to add.

5761

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5762

# The default value is false.

5763

},

5764

],

5765

"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.

5770

"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.

5771

# 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.

5772

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5773

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5774

"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.

5775

"A String",

5776

],

5777

"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.

5778

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

5779

# 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]

5780

"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

5781

"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.

5782

# Default is false.

5783

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5784

"A String",

5785

],

5786

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5787

"A String",

5788

],

5789

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5790

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5791

"A String",

5792

],

5793

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5794

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5795

"A String",

5796

],

5797

"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.

5798

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5799

"A String",

5800

],

5801

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5802

},

5803

"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.

5804

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5805

"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.

5806

"httpStatus": 42, # The HTTP status code used to abort the request.

5807

# The value must be between 200 and 599 inclusive.

5808

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5809

# The value must be between 0.0 and 100.0 inclusive.

5810

},

5811

"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.

5812

"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.

5813

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5814

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5815

},

5816

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5817

# The value must be between 0.0 and 100.0 inclusive.

5818

},

5819

},

5820

"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.

5821

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5822

},

5823

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5824

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5825

"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.

5826

# 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.

5827

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5828

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5829

},

5830

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5831

# - 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.

5832

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5833

# -

5834

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5835

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5836

# - 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.

5837

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5838

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5839

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5840

# - 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.

5845

# If not specified, will use the largest timeout among all backend services associated with the route.

5846

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5847

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5848

},

5849

"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^]

5850

# 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]

5851

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5852

# The value must be between 1 and 255 characters.

5853

"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.

5854

# The value must be between 1 and 1024 characters.

5855

},

5856

"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.

5857

# 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.

5858

{ # 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

5859

"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.

5860

"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.

5861

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5862

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5863

{ # Specification determining how headers are added to requests or responses.

5864

"headerName": "A String", # The name of the header.

5865

"headerValue": "A String", # The value of the header to add.

5866

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5867

# The default value is false.

5868

},

5869

],

5870

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5871

"A String",

5872

],

5873

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5874

{ # Specification determining how headers are added to requests or responses.

5875

"headerName": "A String", # The name of the header.

5876

"headerValue": "A String", # The value of the header to add.

5877

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5878

# The default value is false.

5879

},

5880

],

5881

"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) .

5886

# 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.

5887

# 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.

5892

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5893

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5894

# If urlRedirect is specified, service or routeAction must not be set.

5895

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5896

# The value must be between 1 and 255 characters.

5897

"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.

5898

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5899

# The default is set to false.

5900

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5901

# 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.

5902

# The value must be between 1 and 1024 characters.

5903

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5904

# 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.

5905

# The value must be between 1 and 1024 characters.

5906

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5907

# Supported values are:

5908

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5909

# - FOUND, which corresponds to 302.

5910

# - SEE_OTHER which corresponds to 303.

5911

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5912

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5913

"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.

5914

# 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.

5919

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5920

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5921

"description": "A String", # The short description conveying the intent of this routeRule.

5922

# The description can have a maximum length of 1024 characters.

5923

"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.

5924

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5925

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5926

{ # Specification determining how headers are added to requests or responses.

5927

"headerName": "A String", # The name of the header.

5928

"headerValue": "A String", # The value of the header to add.

5929

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5930

# The default value is false.

5931

},

5932

],

5933

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5934

"A String",

5935

],

5936

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5937

{ # Specification determining how headers are added to requests or responses.

5938

"headerName": "A String", # The name of the header.

5939

"headerValue": "A String", # The value of the header to add.

5940

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5941

# The default value is false.

5942

},

5943

],

5944

"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.

5950

"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.

5951

# fullPathMatch must be between 1 and 1024 characters.

5952

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5953

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5954

{ # matchRule criteria for request header matches.

5955

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5956

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5957

"headerName": "A String", # The name of the HTTP header to match.

5958

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5959

# For matching a request's method, use the headerName ":method".

5960

"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.

5961

# The default setting is false.

5962

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5963

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5964

"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.

5965

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5966

"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.

5967

# For example for a range [-5, 0]

5968

# - -3 will match.

5969

# - 0 will not match.

5970

# - 0.25 will not match.

5971

# - -3someString will not match.

5972

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5973

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5974

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5975

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5976

},

5977

"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

5978

# 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.

5979

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5980

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5981

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5982

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5983

},

5984

],

5985

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5986

# The default value is false.

5987

# ignoreCase must not be used with regexMatch.

5988

"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.

5989

# 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.

5990

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5991

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5992

{ # 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.

5993

# 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.

5994

# 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.

5995

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5996

# This list must not be empty and can have at the most 64 entries.

5997

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5998

"name": "A String", # Name of metadata label.

5999

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

6000

"value": "A String", # The value of the label must match the specified value.

6001

# value can have a maximum length of 1024 characters.

6002

},

6003

],

6004

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

6005

# Supported values are:

6006

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

6007

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

6008

},

6009

],

6010

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

6011

# The value must be between 1 and 1024 characters.

6012

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6013

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

6014

{ # HttpRouteRuleMatch criteria for a request's query parameter.

6015

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

6016

# Only one of presentMatch, exactMatch or regexMatch must be set.

6017

"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.

6018

"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.

6019

# Only one of presentMatch, exactMatch or regexMatch must be set.

6020

"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

6021

# Only one of presentMatch, exactMatch or regexMatch must be set.

6022

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

6023

},

6024

],

6025

"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

6026

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6027

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6028

},

6029

],

6030

"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.

6031

# 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.

6032

# 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.

6033

"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.

6034

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6035

"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

6036

"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.

6037

# Default is false.

6038

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6039

"A String",

6040

],

6041

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6042

"A String",

6043

],

6044

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6045

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6046

"A String",

6047

],

6048

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6049

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6050

"A String",

6051

],

6052

"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.

6053

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6054

"A String",

6055

],

6056

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6057

},

6058

"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.

6059

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

6060

"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.

6061

"httpStatus": 42, # The HTTP status code used to abort the request.

6062

# The value must be between 200 and 599 inclusive.

6063

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6064

# The value must be between 0.0 and 100.0 inclusive.

6065

},

6066

"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.

6067

"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.

6068

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6069

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6070

},

6071

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6072

# The value must be between 0.0 and 100.0 inclusive.

6073

},

6074

},

6075

"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.

6076

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6077

},

6078

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

6079

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6080

"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.

6081

# 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.

6082

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6083

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6084

},

6085

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6086

# - 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.

6087

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6088

# -

6089

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6090

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6091

# - 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.

6092

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6093

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6094

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6095

# - 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.

6100

# If not specified, will use the largest timeout among all backend services associated with the route.

6101

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6102

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6103

},

6104

"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^]

6105

# 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]

6106

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6107

# The value must be between 1 and 255 characters.

6108

"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.

6109

# The value must be between 1 and 1024 characters.

6110

},

6111

"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.

6112

# 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.

6113

{ # 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

6114

"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.

6115

"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.

6116

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

6117

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6118

{ # Specification determining how headers are added to requests or responses.

6119

"headerName": "A String", # The name of the header.

6120

"headerValue": "A String", # The value of the header to add.

6121

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6122

# The default value is false.

6123

},

6124

],

6125

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6126

"A String",

6127

],

6128

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6129

{ # Specification determining how headers are added to requests or responses.

6130

"headerName": "A String", # The name of the header.

6131

"headerValue": "A String", # The value of the header to add.

6132

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6133

# The default value is false.

6134

},

6135

],

6136

"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) .

6141

# 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.

6142

# 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.

6147

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6148

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

6149

# If urlRedirect is specified, service or routeAction must not be set.

6150

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6151

# The value must be between 1 and 255 characters.

6152

"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.

6153

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6154

# The default is set to false.

6155

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6156

# 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.

6157

# The value must be between 1 and 1024 characters.

6158

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6159

# 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.

6160

# The value must be between 1 and 1024 characters.

6161

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6162

# Supported values are:

6163

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6164

# - FOUND, which corresponds to 302.

6165

# - SEE_OTHER which corresponds to 303.

6166

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6167

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6168

"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.

6169

# 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.

6176

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6177

"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.

6178

{ # Message for the expected URL mappings.

6179

"description": "A String", # Description of this test case.

6180

"host": "A String", # Host portion of the URL.

6181

"path": "A String", # Path portion of the URL.

6182

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

6183

},

6184

],

6185

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}

Returns:

An object of the form:

6191

6192

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6193

"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.

6198

"testFailures": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6199

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6200

"actualService": "A String",

6201

"expectedService": "A String",

6202

"host": "A String",

6203

"path": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6204

},

6205

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6206

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

Sai Cheemalapati