Blame - docs/dyn/compute_alpha.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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

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, returnPartialSuccess=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, returnPartialSuccess=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.

135

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

136

137

Returns:

138

An object of the form:

139

140

{

Bu Sun Kim

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

[diff] [blame]

141

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

142

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

143

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

144

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

Dan O'Meara

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

[diff] [blame]

145

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

146

#

147

# Google Compute Engine has two URL Map resources:

148

#

149

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

150

#

151

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

152

#

153

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

154

#

155

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

156

#

157

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

158

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

159

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

160

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

161

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

162

"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

163

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

164

# Default is false.

165

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

166

"A String",

Bu Sun Kim

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

[diff] [blame]

167

],

Bu Sun Kim

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

[diff] [blame]

168

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

169

"A String",

170

],

171

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

172

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

173

"A String",

174

],

175

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

176

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

177

"A String",

178

],

179

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

180

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

181

"A String",

182

],

183

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

184

},

185

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

186

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

187

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

188

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

189

# The value must be between 200 and 599 inclusive.

190

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

191

# The value must be between 0.0 and 100.0 inclusive.

192

},

193

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

194

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

195

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

196

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

197

},

198

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

199

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

200

},

201

},

Bu Sun Kim

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

[diff] [blame]

202

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

203

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

204

},

205

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

206

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

207

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

208

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

209

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

210

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

211

},

Bu Sun Kim

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

[diff] [blame]

212

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

213

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

214

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

215

# -

216

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

217

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

218

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

219

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

220

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

221

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

222

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

223

"A String",

Bu Sun Kim

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

[diff] [blame]

224

],

225

},

Bu Sun Kim

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

[diff] [blame]

226

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

227

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

228

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

229

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

230

},

231

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

232

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

233

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

234

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

235

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

236

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

237

},

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

# The default value is false.

250

},

251

],

252

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

253

"A String",

254

],

255

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

256

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

257

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

258

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

259

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

260

# The default value is false.

261

},

262

],

263

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

268

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

269

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

270

},

271

],

Bu Sun Kim

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

[diff] [blame]

272

},

Bu Sun Kim

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

[diff] [blame]

273

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

274

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

275

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

276

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

277

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

278

# The value must be between 1 and 255 characters.

279

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

280

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

281

# The default is set to false.

282

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

283

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

284

# The value must be between 1 and 1024 characters.

285

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

286

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

287

# The value must be between 1 and 1024 characters.

288

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

289

# Supported values are:

290

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

291

# - FOUND, which corresponds to 302.

292

# - SEE_OTHER which corresponds to 303.

293

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

294

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

295

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

296

# The default is set to false.

297

},

298

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

299

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

300

#

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

# The default value is false.

310

},

311

],

312

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

313

"A String",

314

],

315

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

316

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

317

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

318

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

319

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

320

# The default value is false.

321

},

322

],

323

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

328

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

329

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

330

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

331

"A String",

332

],

333

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

334

},

335

],

336

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

337

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

338

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

339

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

340

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

341

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

342

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

343

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

344

"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

345

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

346

# Default is false.

347

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

348

"A String",

349

],

350

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

351

"A String",

352

],

353

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

354

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

355

"A String",

356

],

357

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

358

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

359

"A String",

360

],

361

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

362

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

363

"A String",

364

],

365

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

366

},

367

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

368

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

369

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

370

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

371

# The value must be between 200 and 599 inclusive.

372

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

373

# The value must be between 0.0 and 100.0 inclusive.

374

},

375

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

376

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

377

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

378

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

379

},

380

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

381

# The value must be between 0.0 and 100.0 inclusive.

382

},

383

},

384

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

385

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

386

},

387

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

388

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

389

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

390

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

391

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

392

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

393

},

394

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

395

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

396

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

397

# -

398

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

399

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

400

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

401

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

402

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

403

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

404

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

409

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

410

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

411

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

412

},

413

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

414

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

415

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

416

# The value must be between 1 and 255 characters.

417

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

418

# The value must be between 1 and 1024 characters.

419

},

420

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

421

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

422

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

423

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

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

# The default value is false.

432

},

433

],

434

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

435

"A String",

436

],

437

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

438

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

439

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

440

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

441

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

442

# The default value is false.

443

},

444

],

445

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

450

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

451

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

456

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

457

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

458

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

459

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

460

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

461

# - compute.backendBuckets.use

462

# - compute.backendServices.use

463

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

464

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

465

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

466

# The value must be between 1 and 255 characters.

467

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

468

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

469

# The default is set to false.

470

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

471

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

472

# The value must be between 1 and 1024 characters.

473

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

474

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

475

# The value must be between 1 and 1024 characters.

476

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

477

# Supported values are:

478

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

479

# - FOUND, which corresponds to 302.

480

# - SEE_OTHER which corresponds to 303.

481

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

482

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

483

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

484

# The default is set to false.

485

},

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

# The default value is false.

495

},

496

],

497

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

498

"A String",

499

],

500

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

501

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

502

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

503

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

504

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

505

# The default value is false.

506

},

507

],

508

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

513

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

514

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

515

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

516

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

517

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

518

"A String",

519

],

520

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

521

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

522

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

523

"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

524

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

525

# Default is false.

526

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

527

"A String",

528

],

529

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

530

"A String",

531

],

532

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

533

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

534

"A String",

535

],

536

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

537

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

538

"A String",

539

],

540

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

541

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

542

"A String",

543

],

544

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

545

},

546

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

547

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

548

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

549

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

550

# The value must be between 200 and 599 inclusive.

551

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

552

# The value must be between 0.0 and 100.0 inclusive.

553

},

554

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

555

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

556

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

557

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

558

},

559

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

560

# The value must be between 0.0 and 100.0 inclusive.

561

},

562

},

563

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

564

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

565

},

566

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

567

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

568

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

569

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

570

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

571

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

572

},

573

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

574

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

575

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

576

# -

577

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

578

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

579

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

580

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

581

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

582

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

583

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

588

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

589

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

590

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

591

},

592

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

593

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

594

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

595

# The value must be between 1 and 255 characters.

596

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

597

# The value must be between 1 and 1024 characters.

598

},

599

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

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

# The default value is false.

611

},

612

],

613

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

614

"A String",

615

],

616

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

617

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

618

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

619

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

620

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

621

# The default value is false.

622

},

623

],

624

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

629

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

630

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

635

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

636

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

637

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

638

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

639

# The value must be between 1 and 255 characters.

640

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

641

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

642

# The default is set to false.

643

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

644

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

645

# The value must be between 1 and 1024 characters.

646

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

647

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

648

# The value must be between 1 and 1024 characters.

649

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

650

# Supported values are:

651

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

652

# - FOUND, which corresponds to 302.

653

# - SEE_OTHER which corresponds to 303.

654

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

655

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

656

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

657

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

662

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

663

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

664

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

665

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

666

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

667

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

668

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

669

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

670

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

671

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

672

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

673

# The default value is false.

674

},

675

],

676

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

677

"A String",

678

],

679

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

680

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

681

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

682

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

683

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

684

# The default value is false.

685

},

686

],

687

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

"A String",

],

},

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

692

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

693

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

694

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

695

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

696

},

697

],

698

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

699

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

700

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

701

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

702

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

703

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

},

],

"matchRules": [

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

708

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

709

# fullPathMatch must be between 1 and 1024 characters.

710

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

711

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

712

{ # matchRule criteria for request header matches.

713

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

714

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

715

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

716

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

717

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

718

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

719

# The default setting is false.

720

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

721

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

722

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

723

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

724

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

725

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

726

# - -3 will match.

727

# - 0 will not match.

728

# - 0.25 will not match.

729

# - -3someString will not match.

730

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

731

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

732

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

733

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

734

},

735

"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

736

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

737

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

738

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

739

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

740

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

741

},

742

],

743

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

744

# The default value is false.

745

# ignoreCase must not be used with regexMatch.

746

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

747

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

748

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

749

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

750

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

751

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

752

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

753

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

754

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

755

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

756

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

757

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

758

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

759

# value can have a maximum length of 1024 characters.

760

},

761

],

762

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

763

# Supported values are:

764

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

765

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

766

},

767

],

768

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

769

# The value must be between 1 and 1024 characters.

770

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

771

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

772

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

773

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

774

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

775

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

776

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

777

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

778

"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

779

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

780

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

781

},

782

],

783

"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

784

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

785

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

786

},

787

],

788

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

789

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

790

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

791

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

792

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

793

"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

794

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

795

# Default is false.

796

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

797

"A String",

798

],

799

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

800

"A String",

801

],

802

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

803

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

804

"A String",

805

],

806

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

807

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

808

"A String",

809

],

810

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

811

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

812

"A String",

813

],

814

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

815

},

816

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

817

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

818

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

819

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

820

# The value must be between 200 and 599 inclusive.

821

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

822

# The value must be between 0.0 and 100.0 inclusive.

823

},

824

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

825

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

826

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

827

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

828

},

829

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

830

# The value must be between 0.0 and 100.0 inclusive.

831

},

832

},

833

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

834

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

835

},

836

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

837

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

838

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

839

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

840

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

841

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

842

},

843

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

844

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

845

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

846

# -

847

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

848

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

849

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

850

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

851

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

852

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

853

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

858

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

859

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

860

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

861

},

862

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

863

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

864

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

865

# The value must be between 1 and 255 characters.

866

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

867

# The value must be between 1 and 1024 characters.

868

},

869

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

870

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

871

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

872

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

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

# The default value is false.

881

},

882

],

883

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

884

"A String",

885

],

886

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

887

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

888

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

889

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

890

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

891

# The default value is false.

892

},

893

],

894

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

899

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

900

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

905

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

906

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

907

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

908

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

909

# The value must be between 1 and 255 characters.

910

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

911

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

912

# The default is set to false.

913

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

914

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

915

# The value must be between 1 and 1024 characters.

916

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

917

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

918

# The value must be between 1 and 1024 characters.

919

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

920

# Supported values are:

921

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

922

# - FOUND, which corresponds to 302.

923

# - SEE_OTHER which corresponds to 303.

924

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

925

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

926

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

927

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

934

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

935

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

936

{ # Message for the expected URL mappings.

937

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

938

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

939

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

940

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

941

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

942

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

943

},

944

],

945

},

Bu Sun Kim

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

[diff] [blame]

946

],

Bu Sun Kim

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

[diff] [blame]

947

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

948

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

949

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

950

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

Bu Sun Kim

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

[diff] [blame]

951

{

Bu Sun Kim

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

[diff] [blame]

952

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

953

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

954

},

955

],

Bu Sun Kim

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

[diff] [blame]

956

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

957

},

958

},

959

},

Bu Sun Kim

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

[diff] [blame]

960

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

961

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

962

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

963

"unreachables": [ # [Output Only] Unreachable resources.

964

"A String",

965

],

966

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

967

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

968

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

969

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

Bu Sun Kim

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

[diff] [blame]

970

{

Bu Sun Kim

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

[diff] [blame]

971

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

972

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

973

},

974

],

Bu Sun Kim

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

[diff] [blame]

975

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

976

},

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>

982

<pre>Retrieves the next page of results.

983

984

Args:

985

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

986

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

987

988

Returns:

Bu Sun Kim

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

[diff] [blame]

989

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]

990

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

</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

995

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

Sai Cheemalapati

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

[diff] [blame]

996

<pre>Deletes the specified UrlMap resource.

997

998

Args:

999

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

1000

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

Bu Sun Kim

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

[diff] [blame]

1001

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.

1002

1003

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.

1004

1005

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]

1006

1007

Returns:

1008

An object of the form:

1009

Bu Sun Kim

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

[diff] [blame]

1010

{ # Represents an Operation resource.

1011

#

Dan O'Meara

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

[diff] [blame]

1012

# Google Compute Engine has three Operation resources:

1013

#

1014

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

1015

#

Bu Sun Kim

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

[diff] [blame]

1016

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

1017

#

1018

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1019

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

1020

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

1021

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

Bu Sun Kim

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

[diff] [blame]

1022

#

Dan O'Meara

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

[diff] [blame]

1023

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

1024

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

1025

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

1026

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

1027

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

1028

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

1029

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

Sai Cheemalapati

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

[diff] [blame]

1030

{

Bu Sun Kim

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

[diff] [blame]

1031

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

1032

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

1033

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

Sai Cheemalapati

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

[diff] [blame]

1034

},

1035

],

1036

},

Bu Sun Kim

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

[diff] [blame]

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

{

1056

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

1057

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

1058

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

1059

{

1060

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

1061

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

1062

},

1063

],

1064

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

1065

},

1066

],

1067

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

1073

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

1074

1075

Args:

1076

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

1077

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

1078

1079

Returns:

1080

An object of the form:

1081

Dan O'Meara

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

[diff] [blame]

1082

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1083

#

1084

# Google Compute Engine has two URL Map resources:

1085

#

1086

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

1087

#

1088

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

1089

#

1090

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

1091

#

1092

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

1093

#

1094

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

1095

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

1096

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

1097

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

1098

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

1099

"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

1100

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

1101

# Default is false.

1102

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

1103

"A String",

Bu Sun Kim

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

[diff] [blame]

1104

],

Bu Sun Kim

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

[diff] [blame]

1105

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

1106

"A String",

1107

],

1108

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

1109

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

1110

"A String",

1111

],

1112

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

1113

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

1114

"A String",

1115

],

1116

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

1117

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

1118

"A String",

1119

],

1120

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

1121

},

1122

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

1123

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

1124

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

1125

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

1126

# The value must be between 200 and 599 inclusive.

1127

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

1128

# The value must be between 0.0 and 100.0 inclusive.

1129

},

1130

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

1131

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

1132

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

1133

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

1134

},

1135

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

1136

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1137

},

1138

},

Bu Sun Kim

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

[diff] [blame]

1139

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

1140

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

1141

},

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

},

Bu Sun Kim

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

[diff] [blame]

1149

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

1150

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

1151

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

1152

# -

1153

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

1154

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

1155

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

1156

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

1157

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

1158

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

1159

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

1160

"A String",

Bu Sun Kim

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

[diff] [blame]

1161

],

1162

},

Bu Sun Kim

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

[diff] [blame]

1163

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

1164

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

1165

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

1166

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

1167

},

1168

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

1169

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

1170

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

1171

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

1172

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

1173

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1174

},

Bu Sun Kim

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

[diff] [blame]

1175

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

1176

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

1177

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

1178

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

1179

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

1180

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

1181

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

1182

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

1183

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

1184

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

1185

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

1186

# The default value is false.

1187

},

1188

],

1189

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

1190

"A String",

1191

],

1192

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

1193

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

1194

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

1195

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

1196

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

1197

# The default value is false.

1198

},

1199

],

1200

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

1205

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

1206

# The value must be between 0 and 1000

Sai Cheemalapati

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

[diff] [blame]

1207

},

1208

],

Bu Sun Kim

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

[diff] [blame]

1209

},

1210

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

1211

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

1212

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

1213

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

1214

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

1215

# The value must be between 1 and 255 characters.

1216

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

1217

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

1218

# The default is set to false.

1219

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

1220

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

1221

# The value must be between 1 and 1024 characters.

1222

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

1223

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

1224

# The value must be between 1 and 1024 characters.

1225

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

1226

# Supported values are:

1227

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

1228

# - FOUND, which corresponds to 302.

1229

# - SEE_OTHER which corresponds to 303.

1230

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

1231

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

1232

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

1233

# The default is set to false.

1234

},

1235

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

1236

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

1237

#

1238

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

1239

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

1240

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

1241

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

1242

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

1243

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

1244

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

1245

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

1246

# The default value is false.

1247

},

1248

],

1249

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

1250

"A String",

1251

],

1252

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

1253

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

1254

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

1255

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

1256

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

1257

# The default value is false.

1258

},

1259

],

1260

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

1265

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

1266

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

1267

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

1268

"A String",

1269

],

1270

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

1271

},

1272

],

1273

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

1274

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

1275

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

1276

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

1277

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

1278

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

1279

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

1280

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

1281

"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

1282

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

1283

# Default is false.

1284

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

1285

"A String",

1286

],

1287

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

1288

"A String",

1289

],

1290

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

1291

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

1292

"A String",

1293

],

1294

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

1295

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

1296

"A String",

1297

],

1298

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

1299

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

1300

"A String",

1301

],

1302

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

1303

},

1304

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

1305

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

1306

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

1307

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

1308

# The value must be between 200 and 599 inclusive.

1309

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

1310

# The value must be between 0.0 and 100.0 inclusive.

1311

},

1312

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

1313

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

1314

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

1315

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

1316

},

1317

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

1318

# The value must be between 0.0 and 100.0 inclusive.

1319

},

1320

},

1321

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

1322

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

1323

},

1324

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

1325

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

1326

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

1327

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

1328

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

1329

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

1330

},

1331

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

1332

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

1333

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

1334

# -

1335

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

1336

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

1337

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

1338

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

1339

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

1340

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

1341

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

1346

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

1347

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

1348

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

1349

},

1350

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

1351

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

1352

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

1353

# The value must be between 1 and 255 characters.

1354

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

1355

# The value must be between 1 and 1024 characters.

1356

},

1357

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

1358

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

1359

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

1360

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

1361

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

1362

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

1363

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

1364

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

1365

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

1366

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

1367

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

1368

# The default value is false.

1369

},

1370

],

1371

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

1372

"A String",

1373

],

1374

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

1375

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

1376

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

1377

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

1378

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

1379

# The default value is false.

1380

},

1381

],

1382

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

1387

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

1388

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

1393

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

1394

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

1395

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

1396

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

1397

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

1398

# - compute.backendBuckets.use

1399

# - compute.backendServices.use

1400

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

1401

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

1402

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

1403

# The value must be between 1 and 255 characters.

1404

"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.

1405

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1406

# The default is set to false.

1407

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1408

# 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.

1409

# The value must be between 1 and 1024 characters.

1410

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1411

# 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.

1412

# The value must be between 1 and 1024 characters.

1413

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1414

# Supported values are:

1415

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1416

# - FOUND, which corresponds to 302.

1417

# - SEE_OTHER which corresponds to 303.

1418

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1419

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1420

"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.

1421

# The default is set to false.

1422

},

1423

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1424

"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.

1425

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

1426

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1427

{ # Specification determining how headers are added to requests or responses.

1428

"headerName": "A String", # The name of the header.

1429

"headerValue": "A String", # The value of the header to add.

1430

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1431

# The default value is false.

1432

},

1433

],

1434

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1435

"A String",

1436

],

1437

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1438

{ # Specification determining how headers are added to requests or responses.

1439

"headerName": "A String", # The name of the header.

1440

"headerValue": "A String", # The value of the header to add.

1441

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1442

# The default value is false.

1443

},

1444

],

1445

"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.

1450

"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.

1451

# 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.

1452

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1453

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1454

"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.

1455

"A String",

1456

],

1457

"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.

1458

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1459

# 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]

1460

"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

1461

"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.

1462

# Default is false.

1463

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1464

"A String",

1465

],

1466

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1467

"A String",

1468

],

1469

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1470

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1471

"A String",

1472

],

1473

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1474

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1475

"A String",

1476

],

1477

"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.

1478

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1479

"A String",

1480

],

1481

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1482

},

1483

"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.

1484

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1485

"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.

1486

"httpStatus": 42, # The HTTP status code used to abort the request.

1487

# The value must be between 200 and 599 inclusive.

1488

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1489

# The value must be between 0.0 and 100.0 inclusive.

1490

},

1491

"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.

1492

"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.

1493

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1494

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1495

},

1496

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1497

# The value must be between 0.0 and 100.0 inclusive.

1498

},

1499

},

1500

"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.

1501

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1502

},

1503

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1504

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1505

"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.

1506

# 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.

1507

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1508

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1509

},

1510

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1511

# - 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.

1512

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1513

# -

1514

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1515

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1516

# - 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.

1517

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1518

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1519

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1520

# - 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.

1525

# If not specified, will use the largest timeout among all backend services associated with the route.

1526

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1527

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1528

},

1529

"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]

1530

# 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]

1531

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1532

# The value must be between 1 and 255 characters.

1533

"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.

1534

# The value must be between 1 and 1024 characters.

1535

},

1536

"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.

1537

# 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.

1538

{ # 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

1539

"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.

1540

"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.

1541

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1542

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1543

{ # Specification determining how headers are added to requests or responses.

1544

"headerName": "A String", # The name of the header.

1545

"headerValue": "A String", # The value of the header to add.

1546

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1547

# The default value is false.

1548

},

1549

],

1550

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1551

"A String",

1552

],

1553

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1554

{ # Specification determining how headers are added to requests or responses.

1555

"headerName": "A String", # The name of the header.

1556

"headerValue": "A String", # The value of the header to add.

1557

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1558

# The default value is false.

1559

},

1560

],

1561

"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) .

1566

# 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.

1567

# 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.

1572

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1573

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1574

# If urlRedirect is specified, service or routeAction must not be set.

1575

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1576

# The value must be between 1 and 255 characters.

1577

"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.

1578

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1579

# The default is set to false.

1580

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1581

# 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.

1582

# The value must be between 1 and 1024 characters.

1583

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1584

# 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.

1585

# The value must be between 1 and 1024 characters.

1586

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1587

# Supported values are:

1588

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1589

# - FOUND, which corresponds to 302.

1590

# - SEE_OTHER which corresponds to 303.

1591

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1592

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1593

"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.

1594

# 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.

1599

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1600

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1601

"description": "A String", # The short description conveying the intent of this routeRule.

1602

# The description can have a maximum length of 1024 characters.

1603

"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.

1604

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

1605

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1606

{ # Specification determining how headers are added to requests or responses.

1607

"headerName": "A String", # The name of the header.

1608

"headerValue": "A String", # The value of the header to add.

1609

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1610

# The default value is false.

1611

},

1612

],

1613

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1614

"A String",

1615

],

1616

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1617

{ # Specification determining how headers are added to requests or responses.

1618

"headerName": "A String", # The name of the header.

1619

"headerValue": "A String", # The value of the header to add.

1620

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1621

# The default value is false.

1622

},

1623

],

1624

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

1629

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

1630

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

1631

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

1632

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

1633

},

1634

],

1635

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

1636

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

1637

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

1638

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

1639

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

1640

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

1645

"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.

1646

# fullPathMatch must be between 1 and 1024 characters.

1647

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1648

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1649

{ # matchRule criteria for request header matches.

1650

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1651

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1652

"headerName": "A String", # The name of the HTTP header to match.

1653

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1654

# For matching a request's method, use the headerName ":method".

1655

"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.

1656

# The default setting is false.

1657

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1658

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1659

"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.

1660

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1661

"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.

1662

# For example for a range [-5, 0]

1663

# - -3 will match.

1664

# - 0 will not match.

1665

# - 0.25 will not match.

1666

# - -3someString will not match.

1667

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1668

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1669

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1670

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1671

},

1672

"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

1673

# 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.

1674

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1675

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1676

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1677

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1678

},

1679

],

1680

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1681

# The default value is false.

1682

# ignoreCase must not be used with regexMatch.

1683

"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.

1684

# 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.

1685

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1686

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1687

{ # 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.

1688

# 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.

1689

# 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.

1690

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1691

# This list must not be empty and can have at the most 64 entries.

1692

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1693

"name": "A String", # Name of metadata label.

1694

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1695

"value": "A String", # The value of the label must match the specified value.

1696

# value can have a maximum length of 1024 characters.

1697

},

1698

],

1699

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1700

# Supported values are:

1701

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1702

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1703

},

1704

],

1705

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1706

# The value must be between 1 and 1024 characters.

1707

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1708

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

1709

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1710

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1711

# Only one of presentMatch, exactMatch or regexMatch must be set.

1712

"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.

1713

"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.

1714

# Only one of presentMatch, exactMatch or regexMatch must be set.

1715

"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

1716

# Only one of presentMatch, exactMatch or regexMatch must be set.

1717

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1718

},

1719

],

1720

"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

1721

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1722

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1723

},

1724

],

1725

"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.

1726

# 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.

1727

# 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.

1728

"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.

1729

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1730

"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

1731

"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.

1732

# Default is false.

1733

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1734

"A String",

1735

],

1736

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1737

"A String",

1738

],

1739

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1740

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1741

"A String",

1742

],

1743

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1744

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1745

"A String",

1746

],

1747

"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.

1748

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1749

"A String",

1750

],

1751

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1752

},

1753

"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.

1754

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1755

"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.

1756

"httpStatus": 42, # The HTTP status code used to abort the request.

1757

# The value must be between 200 and 599 inclusive.

1758

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1759

# The value must be between 0.0 and 100.0 inclusive.

1760

},

1761

"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.

1762

"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.

1763

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1764

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1765

},

1766

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1767

# The value must be between 0.0 and 100.0 inclusive.

1768

},

1769

},

1770

"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.

1771

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1772

},

1773

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1774

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1775

"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.

1776

# 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.

1777

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1778

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1779

},

1780

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1781

# - 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.

1782

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1783

# -

1784

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1785

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1786

# - 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.

1787

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1788

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1789

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1790

# - 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.

1795

# If not specified, will use the largest timeout among all backend services associated with the route.

1796

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1797

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1798

},

1799

"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]

1800

# 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]

1801

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1802

# The value must be between 1 and 255 characters.

1803

"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.

1804

# The value must be between 1 and 1024 characters.

1805

},

1806

"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.

1807

# 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.

1808

{ # 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

1809

"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.

1810

"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.

1811

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1812

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1813

{ # Specification determining how headers are added to requests or responses.

1814

"headerName": "A String", # The name of the header.

1815

"headerValue": "A String", # The value of the header to add.

1816

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1817

# The default value is false.

1818

},

1819

],

1820

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1821

"A String",

1822

],

1823

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1824

{ # Specification determining how headers are added to requests or responses.

1825

"headerName": "A String", # The name of the header.

1826

"headerValue": "A String", # The value of the header to add.

1827

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1828

# The default value is false.

1829

},

1830

],

1831

"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) .

1836

# 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.

1837

# 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.

1842

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1843

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1844

# If urlRedirect is specified, service or routeAction must not be set.

1845

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1846

# The value must be between 1 and 255 characters.

1847

"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.

1848

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1849

# The default is set to false.

1850

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1851

# 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.

1852

# The value must be between 1 and 1024 characters.

1853

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1854

# 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.

1855

# The value must be between 1 and 1024 characters.

1856

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1857

# Supported values are:

1858

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1859

# - FOUND, which corresponds to 302.

1860

# - SEE_OTHER which corresponds to 303.

1861

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1862

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1863

"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.

1864

# 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.

1871

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1872

"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.

1873

{ # Message for the expected URL mappings.

1874

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

1875

"description": "A String", # Description of this test case.

1876

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

1877

"host": "A String", # Host portion of the URL.

1878

"path": "A String", # Path portion of the URL.

1879

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

1880

},

1881

],

1882

}</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]

1886

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1887

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

1888

1889

Args:

1890

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1891

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1892

The object takes the form of:

1893

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1894

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1895

#

1896

# Google Compute Engine has two URL Map resources:

1897

#

1898

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1899

#

1900

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1901

#

1902

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1903

#

1904

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1905

#

1906

# 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.

1907

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1908

"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.

1909

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1910

# 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]

1911

"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

1912

"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.

1913

# Default is false.

1914

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1915

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1916

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1917

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1918

"A String",

1919

],

1920

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1921

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1922

"A String",

1923

],

1924

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1925

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1926

"A String",

1927

],

1928

"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.

1929

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1930

"A String",

1931

],

1932

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1933

},

1934

"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.

1935

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

1936

"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.

1937

"httpStatus": 42, # The HTTP status code used to abort the request.

1938

# The value must be between 200 and 599 inclusive.

1939

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1940

# The value must be between 0.0 and 100.0 inclusive.

1941

},

1942

"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.

1943

"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.

1944

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1945

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1946

},

1947

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1948

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1949

},

1950

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1951

"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.

1952

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1953

},

1954

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

1955

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1956

"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.

1957

# 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.

1958

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1959

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

1960

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1961

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1962

# - 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.

1963

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1964

# -

1965

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1966

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1967

# - 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.

1968

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1969

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1970

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1971

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

1972

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1973

],

1974

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1975

"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.

1976

# If not specified, will use the largest timeout among all backend services associated with the route.

1977

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1978

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1979

},

1980

"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]

1981

# 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]

1982

"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]

1983

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1984

"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.

1985

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1986

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1987

"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.

1988

# 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.

1989

{ # 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

1990

"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.

1991

"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.

1992

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

1993

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1994

{ # Specification determining how headers are added to requests or responses.

1995

"headerName": "A String", # The name of the header.

1996

"headerValue": "A String", # The value of the header to add.

1997

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1998

# The default value is false.

1999

},

2000

],

2001

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2002

"A String",

2003

],

2004

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2005

{ # Specification determining how headers are added to requests or responses.

2006

"headerName": "A String", # The name of the header.

2007

"headerValue": "A String", # The value of the header to add.

2008

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2009

# The default value is false.

2010

},

2011

],

2012

"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) .

2017

# 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.

2018

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2019

},

2020

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2021

},

2022

"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.

2023

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2024

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2025

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2026

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2027

# The value must be between 1 and 255 characters.

2028

"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.

2029

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2030

# The default is set to false.

2031

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2032

# 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.

2033

# The value must be between 1 and 1024 characters.

2034

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2035

# 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.

2036

# The value must be between 1 and 1024 characters.

2037

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2038

# Supported values are:

2039

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2040

# - FOUND, which corresponds to 302.

2041

# - SEE_OTHER which corresponds to 303.

2042

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2043

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2044

"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.

2045

# The default is set to false.

2046

},

2047

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2048

"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.

2049

#

2050

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2051

"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.

2052

# The headerAction specified here take effect after headerAction specified under pathMatcher.

2053

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2054

{ # Specification determining how headers are added to requests or responses.

2055

"headerName": "A String", # The name of the header.

2056

"headerValue": "A String", # The value of the header to add.

2057

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2058

# The default value is false.

2059

},

2060

],

2061

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2062

"A String",

2063

],

2064

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2065

{ # Specification determining how headers are added to requests or responses.

2066

"headerName": "A String", # The name of the header.

2067

"headerValue": "A String", # The value of the header to add.

2068

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2069

# The default value is false.

2070

},

2071

],

2072

"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.

2077

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2078

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2079

"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 ..

2080

"A String",

2081

],

2082

"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.

2083

},

2084

],

2085

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2086

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2087

"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.

2088

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2089

{ # 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.

2090

"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.

2091

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2092

# 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]

2093

"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

2094

"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.

2095

# Default is false.

2096

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2097

"A String",

2098

],

2099

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2100

"A String",

2101

],

2102

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2103

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2104

"A String",

2105

],

2106

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2107

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2108

"A String",

2109

],

2110

"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.

2111

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2112

"A String",

2113

],

2114

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2115

},

2116

"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.

2117

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2118

"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.

2119

"httpStatus": 42, # The HTTP status code used to abort the request.

2120

# The value must be between 200 and 599 inclusive.

2121

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2122

# The value must be between 0.0 and 100.0 inclusive.

2123

},

2124

"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.

2125

"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.

2126

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2127

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2128

},

2129

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2130

# The value must be between 0.0 and 100.0 inclusive.

2131

},

2132

},

2133

"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.

2134

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2135

},

2136

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2137

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2138

"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.

2139

# 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.

2140

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2141

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2142

},

2143

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2144

# - 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.

2145

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2146

# -

2147

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2148

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2149

# - 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.

2150

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2151

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2152

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2153

# - 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.

2158

# If not specified, will use the largest timeout among all backend services associated with the route.

2159

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2160

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2161

},

2162

"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]

2163

# 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]

2164

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2165

# The value must be between 1 and 255 characters.

2166

"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.

2167

# The value must be between 1 and 1024 characters.

2168

},

2169

"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.

2170

# 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.

2171

{ # 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

2172

"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.

2173

"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.

2174

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2175

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2176

{ # Specification determining how headers are added to requests or responses.

2177

"headerName": "A String", # The name of the header.

2178

"headerValue": "A String", # The value of the header to add.

2179

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2180

# The default value is false.

2181

},

2182

],

2183

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2184

"A String",

2185

],

2186

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2187

{ # Specification determining how headers are added to requests or responses.

2188

"headerName": "A String", # The name of the header.

2189

"headerValue": "A String", # The value of the header to add.

2190

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2191

# The default value is false.

2192

},

2193

],

2194

"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) .

2199

# 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.

2200

# 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:

2205

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2206

# - compute/v1/projects/project/global/backendServices/backendService

2207

# - 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.

2208

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2209

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2210

# - compute.backendBuckets.use

2211

# - compute.backendServices.use

2212

"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.

2213

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

2214

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2215

# The value must be between 1 and 255 characters.

2216

"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.

2217

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2218

# The default is set to false.

2219

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2220

# 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.

2221

# The value must be between 1 and 1024 characters.

2222

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2223

# 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.

2224

# The value must be between 1 and 1024 characters.

2225

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2226

# Supported values are:

2227

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2228

# - FOUND, which corresponds to 302.

2229

# - SEE_OTHER which corresponds to 303.

2230

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2231

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2232

"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.

2233

# The default is set to false.

2234

},

2235

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2236

"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.

2237

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

2238

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2239

{ # Specification determining how headers are added to requests or responses.

2240

"headerName": "A String", # The name of the header.

2241

"headerValue": "A String", # The value of the header to add.

2242

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2243

# The default value is false.

2244

},

2245

],

2246

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2247

"A String",

2248

],

2249

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2250

{ # Specification determining how headers are added to requests or responses.

2251

"headerName": "A String", # The name of the header.

2252

"headerValue": "A String", # The value of the header to add.

2253

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2254

# The default value is false.

2255

},

2256

],

2257

"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.

2262

"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.

2263

# 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.

2264

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2265

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2266

"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.

2267

"A String",

2268

],

2269

"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.

2270

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2271

# 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]

2272

"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

2273

"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.

2274

# Default is false.

2275

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2276

"A String",

2277

],

2278

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2279

"A String",

2280

],

2281

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2282

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2283

"A String",

2284

],

2285

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2286

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2287

"A String",

2288

],

2289

"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.

2290

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2291

"A String",

2292

],

2293

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2294

},

2295

"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.

2296

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2297

"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.

2298

"httpStatus": 42, # The HTTP status code used to abort the request.

2299

# The value must be between 200 and 599 inclusive.

2300

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2301

# The value must be between 0.0 and 100.0 inclusive.

2302

},

2303

"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.

2304

"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.

2305

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2306

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2307

},

2308

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2309

# The value must be between 0.0 and 100.0 inclusive.

2310

},

2311

},

2312

"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.

2313

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2314

},

2315

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2316

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2317

"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.

2318

# 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.

2319

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2320

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2321

},

2322

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2323

# - 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.

2324

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2325

# -

2326

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2327

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2328

# - 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.

2329

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2330

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2331

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2332

# - 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.

2337

# If not specified, will use the largest timeout among all backend services associated with the route.

2338

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2339

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2340

},

2341

"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]

2342

# 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]

2343

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2344

# The value must be between 1 and 255 characters.

2345

"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.

2346

# The value must be between 1 and 1024 characters.

2347

},

2348

"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.

2349

# 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.

2350

{ # 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

2351

"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.

2352

"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.

2353

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2354

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2355

{ # Specification determining how headers are added to requests or responses.

2356

"headerName": "A String", # The name of the header.

2357

"headerValue": "A String", # The value of the header to add.

2358

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2359

# The default value is false.

2360

},

2361

],

2362

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2363

"A String",

2364

],

2365

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2366

{ # Specification determining how headers are added to requests or responses.

2367

"headerName": "A String", # The name of the header.

2368

"headerValue": "A String", # The value of the header to add.

2369

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2370

# The default value is false.

2371

},

2372

],

2373

"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) .

2378

# 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.

2379

# 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.

2384

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2385

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2386

# If urlRedirect is specified, service or routeAction must not be set.

2387

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2388

# The value must be between 1 and 255 characters.

2389

"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.

2390

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2391

# The default is set to false.

2392

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2393

# 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.

2394

# The value must be between 1 and 1024 characters.

2395

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2396

# 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.

2397

# The value must be between 1 and 1024 characters.

2398

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2399

# Supported values are:

2400

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2401

# - FOUND, which corresponds to 302.

2402

# - SEE_OTHER which corresponds to 303.

2403

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2404

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2405

"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.

2406

# 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.

2411

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2412

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2413

"description": "A String", # The short description conveying the intent of this routeRule.

2414

# The description can have a maximum length of 1024 characters.

2415

"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.

2416

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

2417

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2418

{ # Specification determining how headers are added to requests or responses.

2419

"headerName": "A String", # The name of the header.

2420

"headerValue": "A String", # The value of the header to add.

2421

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2422

# The default value is false.

2423

},

2424

],

2425

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2426

"A String",

2427

],

2428

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2429

{ # Specification determining how headers are added to requests or responses.

2430

"headerName": "A String", # The name of the header.

2431

"headerValue": "A String", # The value of the header to add.

2432

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2433

# The default value is false.

2434

},

2435

],

2436

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

2441

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

2442

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

2443

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

2444

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

2445

},

2446

],

2447

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

2448

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

2449

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

2450

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

2451

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

2452

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

2457

"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.

2458

# fullPathMatch must be between 1 and 1024 characters.

2459

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2460

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2461

{ # matchRule criteria for request header matches.

2462

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2463

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2464

"headerName": "A String", # The name of the HTTP header to match.

2465

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2466

# For matching a request's method, use the headerName ":method".

2467

"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.

2468

# The default setting is false.

2469

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2470

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2471

"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.

2472

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2473

"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.

2474

# For example for a range [-5, 0]

2475

# - -3 will match.

2476

# - 0 will not match.

2477

# - 0.25 will not match.

2478

# - -3someString will not match.

2479

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2480

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2481

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2482

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2483

},

2484

"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

2485

# 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.

2486

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2487

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2488

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2489

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2490

},

2491

],

2492

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2493

# The default value is false.

2494

# ignoreCase must not be used with regexMatch.

2495

"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.

2496

# 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.

2497

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2498

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2499

{ # 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.

2500

# 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.

2501

# 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.

2502

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2503

# This list must not be empty and can have at the most 64 entries.

2504

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2505

"name": "A String", # Name of metadata label.

2506

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2507

"value": "A String", # The value of the label must match the specified value.

2508

# value can have a maximum length of 1024 characters.

2509

},

2510

],

2511

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2512

# Supported values are:

2513

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2514

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2515

},

2516

],

2517

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2518

# The value must be between 1 and 1024 characters.

2519

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2520

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

2521

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2522

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2523

# Only one of presentMatch, exactMatch or regexMatch must be set.

2524

"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.

2525

"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.

2526

# Only one of presentMatch, exactMatch or regexMatch must be set.

2527

"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

2528

# Only one of presentMatch, exactMatch or regexMatch must be set.

2529

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2530

},

2531

],

2532

"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

2533

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2534

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2535

},

2536

],

2537

"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.

2538

# 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.

2539

# 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.

2540

"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.

2541

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2542

"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

2543

"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.

2544

# Default is false.

2545

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2546

"A String",

2547

],

2548

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2549

"A String",

2550

],

2551

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2552

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2553

"A String",

2554

],

2555

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2556

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2557

"A String",

2558

],

2559

"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.

2560

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2561

"A String",

2562

],

2563

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2564

},

2565

"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.

2566

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2567

"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.

2568

"httpStatus": 42, # The HTTP status code used to abort the request.

2569

# The value must be between 200 and 599 inclusive.

2570

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2571

# The value must be between 0.0 and 100.0 inclusive.

2572

},

2573

"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.

2574

"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.

2575

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2576

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2577

},

2578

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2579

# The value must be between 0.0 and 100.0 inclusive.

2580

},

2581

},

2582

"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.

2583

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2584

},

2585

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2586

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2587

"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.

2588

# 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.

2589

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2590

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2591

},

2592

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2593

# - 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.

2594

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2595

# -

2596

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2597

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2598

# - 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.

2599

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2600

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2601

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2602

# - 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.

2607

# If not specified, will use the largest timeout among all backend services associated with the route.

2608

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2609

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2610

},

2611

"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]

2612

# 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]

2613

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2614

# The value must be between 1 and 255 characters.

2615

"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.

2616

# The value must be between 1 and 1024 characters.

2617

},

2618

"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.

2619

# 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.

2620

{ # 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

2621

"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.

2622

"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.

2623

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2624

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2625

{ # Specification determining how headers are added to requests or responses.

2626

"headerName": "A String", # The name of the header.

2627

"headerValue": "A String", # The value of the header to add.

2628

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2629

# The default value is false.

2630

},

2631

],

2632

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2633

"A String",

2634

],

2635

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2636

{ # Specification determining how headers are added to requests or responses.

2637

"headerName": "A String", # The name of the header.

2638

"headerValue": "A String", # The value of the header to add.

2639

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2640

# The default value is false.

2641

},

2642

],

2643

"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) .

2648

# 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.

2649

# 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.

2654

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2655

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2656

# If urlRedirect is specified, service or routeAction must not be set.

2657

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2658

# The value must be between 1 and 255 characters.

2659

"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.

2660

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2661

# The default is set to false.

2662

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2663

# 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.

2664

# The value must be between 1 and 1024 characters.

2665

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2666

# 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.

2667

# The value must be between 1 and 1024 characters.

2668

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2669

# Supported values are:

2670

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2671

# - FOUND, which corresponds to 302.

2672

# - SEE_OTHER which corresponds to 303.

2673

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2674

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2675

"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.

2676

# 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.

2683

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2684

"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.

2685

{ # Message for the expected URL mappings.

2686

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

2687

"description": "A String", # Description of this test case.

2688

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

2689

"host": "A String", # Host portion of the URL.

2690

"path": "A String", # Path portion of the URL.

2691

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

2692

},

2693

],

2694

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2695

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2696

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.

2697

2698

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.

2699

2700

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]

2701

2702

Returns:

2703

An object of the form:

2704

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2705

{ # Represents an Operation resource.

2706

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2707

# Google Compute Engine has three Operation resources:

2708

#

2709

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2710

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2711

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2712

#

2713

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2714

# - For global operations, use the `globalOperations` resource.

2715

# - For regional operations, use the `regionOperations` resource.

2716

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2717

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2718

# 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]

2719

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2720

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2721

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2722

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2723

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2724

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2725

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2726

"code": "A String", # [Output Only] The error type identifier for this error.

2727

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2728

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2729

},

2730

],

2731

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2732

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2733

"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.

2734

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2735

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2736

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2737

"name": "A String", # [Output Only] Name of the operation.

2738

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2739

"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.

2740

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2741

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2742

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2743

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2744

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2745

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2746

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2747

"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.

2748

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2749

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2750

{

2751

"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.

2752

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2753

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2754

{

2755

"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).

2756

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2757

},

2758

],

2759

"message": "A String", # [Output Only] A human-readable description of the warning code.

2760

},

2761

],

2762

"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]

2767

<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2768

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

2769

2770

Args:

2771

project: string, Project ID for this request. (required)

2772

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2773

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2774

The object takes the form of:

2775

2776

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2777

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

2778

"path": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2779

}

2780

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2781

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.

2782

2783

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.

2784

2785

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]

2786

2787

Returns:

2788

An object of the form:

2789

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2790

{ # Represents an Operation resource.

2791

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2792

# Google Compute Engine has three Operation resources:

2793

#

2794

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2795

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2796

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2797

#

2798

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2799

# - For global operations, use the `globalOperations` resource.

2800

# - For regional operations, use the `regionOperations` resource.

2801

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2802

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2803

# 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]

2804

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2805

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2806

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2807

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2808

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2809

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2810

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2811

"code": "A String", # [Output Only] The error type identifier for this error.

2812

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2813

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2814

},

2815

],

2816

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2817

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2818

"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.

2819

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2820

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2821

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2822

"name": "A String", # [Output Only] Name of the operation.

2823

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2824

"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.

2825

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2826

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2827

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

2828

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2829

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2830

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2831

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2832

"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.

2833

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2834

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2835

{

2836

"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.

2837

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2838

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2839

{

2840

"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).

2841

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2842

},

2843

],

2844

"message": "A String", # [Output Only] A human-readable description of the warning code.

2845

},

2846

],

2847

"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]

2852

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2853

<pre>Retrieves the list of UrlMap resources available to the specified project.

2854

2855

Args:

2856

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2857

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]

2858

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2859

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]

2860

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2861

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]

2862

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2863

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) ```

2864

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`)

2865

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2866

2867

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.

2868

2869

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2870

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.

2871

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2872

2873

Returns:

2874

An object of the form:

2875

2876

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2877

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2878

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2879

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2880

#

2881

# Google Compute Engine has two URL Map resources:

2882

#

2883

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2884

#

2885

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2886

#

2887

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2888

#

2889

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2890

#

2891

# 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.

2892

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2893

"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.

2894

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2895

# 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]

2896

"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

2897

"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.

2898

# Default is false.

2899

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2900

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2901

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2902

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2903

"A String",

2904

],

2905

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2906

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2907

"A String",

2908

],

2909

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2910

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2911

"A String",

2912

],

2913

"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.

2914

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2915

"A String",

2916

],

2917

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2918

},

2919

"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.

2920

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

2921

"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.

2922

"httpStatus": 42, # The HTTP status code used to abort the request.

2923

# The value must be between 200 and 599 inclusive.

2924

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2925

# The value must be between 0.0 and 100.0 inclusive.

2926

},

2927

"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.

2928

"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.

2929

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2930

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2931

},

2932

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2933

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2934

},

2935

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2936

"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.

2937

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2938

},

2939

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

2940

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2941

"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.

2942

# 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.

2943

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2944

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

2945

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2946

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2947

# - 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.

2948

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2949

# -

2950

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2951

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2952

# - 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.

2953

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2954

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2955

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2956

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2957

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2958

],

2959

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2960

"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.

2961

# If not specified, will use the largest timeout among all backend services associated with the route.

2962

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2963

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2964

},

2965

"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]

2966

# 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]

2967

"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]

2968

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2969

"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.

2970

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2971

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2972

"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.

2973

# 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.

2974

{ # 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

2975

"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.

2976

"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.

2977

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

2978

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2979

{ # Specification determining how headers are added to requests or responses.

2980

"headerName": "A String", # The name of the header.

2981

"headerValue": "A String", # The value of the header to add.

2982

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2983

# The default value is false.

2984

},

2985

],

2986

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2987

"A String",

2988

],

2989

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2990

{ # Specification determining how headers are added to requests or responses.

2991

"headerName": "A String", # The name of the header.

2992

"headerValue": "A String", # The value of the header to add.

2993

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2994

# The default value is false.

2995

},

2996

],

2997

"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) .

3002

# 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.

3003

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3004

},

3005

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3006

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3007

"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.

3008

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3009

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3010

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3011

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3012

# The value must be between 1 and 255 characters.

3013

"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.

3014

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3015

# The default is set to false.

3016

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3017

# 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.

3018

# The value must be between 1 and 1024 characters.

3019

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3020

# 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.

3021

# The value must be between 1 and 1024 characters.

3022

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3023

# Supported values are:

3024

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3025

# - FOUND, which corresponds to 302.

3026

# - SEE_OTHER which corresponds to 303.

3027

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3028

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3029

"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.

3030

# The default is set to false.

3031

},

3032

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3033

"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.

3034

#

3035

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3036

"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.

3037

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3038

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3039

{ # Specification determining how headers are added to requests or responses.

3040

"headerName": "A String", # The name of the header.

3041

"headerValue": "A String", # The value of the header to add.

3042

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3043

# The default value is false.

3044

},

3045

],

3046

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3047

"A String",

3048

],

3049

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3050

{ # Specification determining how headers are added to requests or responses.

3051

"headerName": "A String", # The name of the header.

3052

"headerValue": "A String", # The value of the header to add.

3053

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3054

# The default value is false.

3055

},

3056

],

3057

"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.

3062

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3063

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3064

"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 ..

3065

"A String",

3066

],

3067

"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.

3068

},

3069

],

3070

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3071

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3072

"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.

3073

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3074

{ # 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.

3075

"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.

3076

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3077

# 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]

3078

"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

3079

"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.

3080

# Default is false.

3081

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3082

"A String",

3083

],

3084

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3085

"A String",

3086

],

3087

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3088

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3089

"A String",

3090

],

3091

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3092

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3093

"A String",

3094

],

3095

"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.

3096

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3097

"A String",

3098

],

3099

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3100

},

3101

"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.

3102

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3103

"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.

3104

"httpStatus": 42, # The HTTP status code used to abort the request.

3105

# The value must be between 200 and 599 inclusive.

3106

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3107

# The value must be between 0.0 and 100.0 inclusive.

3108

},

3109

"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.

3110

"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.

3111

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3112

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3113

},

3114

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3115

# The value must be between 0.0 and 100.0 inclusive.

3116

},

3117

},

3118

"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.

3119

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3120

},

3121

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3122

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3123

"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.

3124

# 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.

3125

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3126

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3127

},

3128

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3129

# - 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.

3130

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3131

# -

3132

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3133

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3134

# - 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.

3135

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3136

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3137

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3138

# - 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.

3143

# If not specified, will use the largest timeout among all backend services associated with the route.

3144

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3145

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3146

},

3147

"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]

3148

# 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]

3149

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3150

# The value must be between 1 and 255 characters.

3151

"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.

3152

# The value must be between 1 and 1024 characters.

3153

},

3154

"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.

3155

# 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.

3156

{ # 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

3157

"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.

3158

"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.

3159

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3160

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3161

{ # Specification determining how headers are added to requests or responses.

3162

"headerName": "A String", # The name of the header.

3163

"headerValue": "A String", # The value of the header to add.

3164

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3165

# The default value is false.

3166

},

3167

],

3168

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3169

"A String",

3170

],

3171

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3172

{ # Specification determining how headers are added to requests or responses.

3173

"headerName": "A String", # The name of the header.

3174

"headerValue": "A String", # The value of the header to add.

3175

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3176

# The default value is false.

3177

},

3178

],

3179

"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) .

3184

# 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.

3185

# 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:

3190

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3191

# - compute/v1/projects/project/global/backendServices/backendService

3192

# - 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.

3193

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3194

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3195

# - compute.backendBuckets.use

3196

# - compute.backendServices.use

3197

"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.

3198

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3199

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3200

# The value must be between 1 and 255 characters.

3201

"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.

3202

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3203

# The default is set to false.

3204

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3205

# 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.

3206

# The value must be between 1 and 1024 characters.

3207

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3208

# 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.

3209

# The value must be between 1 and 1024 characters.

3210

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3211

# Supported values are:

3212

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3213

# - FOUND, which corresponds to 302.

3214

# - SEE_OTHER which corresponds to 303.

3215

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3216

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3217

"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.

3218

# The default is set to false.

3219

},

3220

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3221

"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.

3222

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

3223

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3224

{ # Specification determining how headers are added to requests or responses.

3225

"headerName": "A String", # The name of the header.

3226

"headerValue": "A String", # The value of the header to add.

3227

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3228

# The default value is false.

3229

},

3230

],

3231

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3232

"A String",

3233

],

3234

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3235

{ # Specification determining how headers are added to requests or responses.

3236

"headerName": "A String", # The name of the header.

3237

"headerValue": "A String", # The value of the header to add.

3238

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3239

# The default value is false.

3240

},

3241

],

3242

"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.

3247

"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.

3248

# 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.

3249

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3250

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3251

"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.

3252

"A String",

3253

],

3254

"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.

3255

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3256

# 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]

3257

"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

3258

"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.

3259

# Default is false.

3260

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3261

"A String",

3262

],

3263

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3264

"A String",

3265

],

3266

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3267

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3268

"A String",

3269

],

3270

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3271

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3272

"A String",

3273

],

3274

"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.

3275

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3276

"A String",

3277

],

3278

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3279

},

3280

"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.

3281

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3282

"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.

3283

"httpStatus": 42, # The HTTP status code used to abort the request.

3284

# The value must be between 200 and 599 inclusive.

3285

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3286

# The value must be between 0.0 and 100.0 inclusive.

3287

},

3288

"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.

3289

"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.

3290

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3291

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3292

},

3293

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3294

# The value must be between 0.0 and 100.0 inclusive.

3295

},

3296

},

3297

"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.

3298

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3299

},

3300

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3301

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3302

"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.

3303

# 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.

3304

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3305

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3306

},

3307

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3308

# - 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.

3309

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3310

# -

3311

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3312

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3313

# - 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.

3314

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3315

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3316

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3317

# - 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.

3322

# If not specified, will use the largest timeout among all backend services associated with the route.

3323

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3324

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3325

},

3326

"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]

3327

# 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]

3328

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3329

# The value must be between 1 and 255 characters.

3330

"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.

3331

# The value must be between 1 and 1024 characters.

3332

},

3333

"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.

3334

# 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.

3335

{ # 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

3336

"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.

3337

"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.

3338

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3339

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3340

{ # Specification determining how headers are added to requests or responses.

3341

"headerName": "A String", # The name of the header.

3342

"headerValue": "A String", # The value of the header to add.

3343

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3344

# The default value is false.

3345

},

3346

],

3347

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3348

"A String",

3349

],

3350

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3351

{ # Specification determining how headers are added to requests or responses.

3352

"headerName": "A String", # The name of the header.

3353

"headerValue": "A String", # The value of the header to add.

3354

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3355

# The default value is false.

3356

},

3357

],

3358

"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) .

3363

# 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.

3364

# 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.

3369

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3370

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3371

# If urlRedirect is specified, service or routeAction must not be set.

3372

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3373

# The value must be between 1 and 255 characters.

3374

"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.

3375

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3376

# The default is set to false.

3377

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3378

# 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.

3379

# The value must be between 1 and 1024 characters.

3380

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3381

# 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.

3382

# The value must be between 1 and 1024 characters.

3383

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3384

# Supported values are:

3385

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3386

# - FOUND, which corresponds to 302.

3387

# - SEE_OTHER which corresponds to 303.

3388

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3389

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3390

"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.

3391

# 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.

3396

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3397

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3398

"description": "A String", # The short description conveying the intent of this routeRule.

3399

# The description can have a maximum length of 1024 characters.

3400

"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.

3401

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

3402

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3403

{ # Specification determining how headers are added to requests or responses.

3404

"headerName": "A String", # The name of the header.

3405

"headerValue": "A String", # The value of the header to add.

3406

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3407

# The default value is false.

3408

},

3409

],

3410

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3411

"A String",

3412

],

3413

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3414

{ # Specification determining how headers are added to requests or responses.

3415

"headerName": "A String", # The name of the header.

3416

"headerValue": "A String", # The value of the header to add.

3417

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3418

# The default value is false.

3419

},

3420

],

3421

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

3426

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

3427

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

3428

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

3429

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

3430

},

3431

],

3432

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

3433

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

3434

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

3435

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

3436

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

3437

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

3442

"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.

3443

# fullPathMatch must be between 1 and 1024 characters.

3444

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3445

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3446

{ # matchRule criteria for request header matches.

3447

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3448

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3449

"headerName": "A String", # The name of the HTTP header to match.

3450

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3451

# For matching a request's method, use the headerName ":method".

3452

"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.

3453

# The default setting is false.

3454

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3455

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3456

"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.

3457

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3458

"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.

3459

# For example for a range [-5, 0]

3460

# - -3 will match.

3461

# - 0 will not match.

3462

# - 0.25 will not match.

3463

# - -3someString will not match.

3464

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3465

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3466

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3467

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3468

},

3469

"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

3470

# 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.

3471

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3472

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3473

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3474

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3475

},

3476

],

3477

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3478

# The default value is false.

3479

# ignoreCase must not be used with regexMatch.

3480

"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.

3481

# 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.

3482

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3483

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3484

{ # 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.

3485

# 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.

3486

# 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.

3487

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3488

# This list must not be empty and can have at the most 64 entries.

3489

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3490

"name": "A String", # Name of metadata label.

3491

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3492

"value": "A String", # The value of the label must match the specified value.

3493

# value can have a maximum length of 1024 characters.

3494

},

3495

],

3496

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3497

# Supported values are:

3498

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3499

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3500

},

3501

],

3502

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3503

# The value must be between 1 and 1024 characters.

3504

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3505

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

3506

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3507

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3508

# Only one of presentMatch, exactMatch or regexMatch must be set.

3509

"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.

3510

"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.

3511

# Only one of presentMatch, exactMatch or regexMatch must be set.

3512

"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

3513

# Only one of presentMatch, exactMatch or regexMatch must be set.

3514

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3515

},

3516

],

3517

"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

3518

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3519

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3520

},

3521

],

3522

"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.

3523

# 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.

3524

# 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.

3525

"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.

3526

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3527

"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

3528

"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.

3529

# Default is false.

3530

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3531

"A String",

3532

],

3533

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3534

"A String",

3535

],

3536

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3537

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3538

"A String",

3539

],

3540

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3541

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3542

"A String",

3543

],

3544

"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.

3545

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3546

"A String",

3547

],

3548

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3549

},

3550

"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.

3551

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3552

"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.

3553

"httpStatus": 42, # The HTTP status code used to abort the request.

3554

# The value must be between 200 and 599 inclusive.

3555

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3556

# The value must be between 0.0 and 100.0 inclusive.

3557

},

3558

"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.

3559

"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.

3560

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3561

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3562

},

3563

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3564

# The value must be between 0.0 and 100.0 inclusive.

3565

},

3566

},

3567

"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.

3568

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3569

},

3570

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3571

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3572

"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.

3573

# 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.

3574

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3575

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3576

},

3577

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3578

# - 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.

3579

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3580

# -

3581

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3582

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3583

# - 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.

3584

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3585

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3586

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3587

# - 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.

3592

# If not specified, will use the largest timeout among all backend services associated with the route.

3593

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3594

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3595

},

3596

"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]

3597

# 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]

3598

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3599

# The value must be between 1 and 255 characters.

3600

"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.

3601

# The value must be between 1 and 1024 characters.

3602

},

3603

"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.

3604

# 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.

3605

{ # 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

3606

"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.

3607

"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.

3608

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3609

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3610

{ # Specification determining how headers are added to requests or responses.

3611

"headerName": "A String", # The name of the header.

3612

"headerValue": "A String", # The value of the header to add.

3613

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3614

# The default value is false.

3615

},

3616

],

3617

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3618

"A String",

3619

],

3620

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3621

{ # Specification determining how headers are added to requests or responses.

3622

"headerName": "A String", # The name of the header.

3623

"headerValue": "A String", # The value of the header to add.

3624

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3625

# The default value is false.

3626

},

3627

],

3628

"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) .

3633

# 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.

3634

# 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.

3639

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3640

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3641

# If urlRedirect is specified, service or routeAction must not be set.

3642

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3643

# The value must be between 1 and 255 characters.

3644

"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.

3645

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3646

# The default is set to false.

3647

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3648

# 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.

3649

# The value must be between 1 and 1024 characters.

3650

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3651

# 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.

3652

# The value must be between 1 and 1024 characters.

3653

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3654

# Supported values are:

3655

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3656

# - FOUND, which corresponds to 302.

3657

# - SEE_OTHER which corresponds to 303.

3658

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3659

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3660

"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.

3661

# 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.

3668

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3669

"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.

3670

{ # Message for the expected URL mappings.

3671

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

3672

"description": "A String", # Description of this test case.

3673

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

3674

"host": "A String", # Host portion of the URL.

3675

"path": "A String", # Path portion of the URL.

3676

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

3677

},

3678

],

3679

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3680

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3681

"kind": "compute#urlMapList", # Type of resource.

3682

"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.

3683

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3684

"warning": { # [Output Only] Informational warning message.

3685

"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.

3686

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3687

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3688

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3689

"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).

3690

"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]

3691

},

3692

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3693

"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]

3694

},

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>

3700

<pre>Retrieves the next page of results.

3701

3702

Args:

3703

previous_request: The request for the previous page. (required)

3704

previous_response: The response from the request for the previous page. (required)

3705

3706

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3707

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3708

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]

3713

<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]

3714

<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]

3715

3716

Args:

3717

project: string, Project ID for this request. (required)

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

3718

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3719

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3720

The object takes the form of:

3721

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3722

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3723

#

3724

# Google Compute Engine has two URL Map resources:

3725

#

3726

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3727

#

3728

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3729

#

3730

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3731

#

3732

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3733

#

3734

# 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.

3735

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3736

"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.

3737

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3738

# 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]

3739

"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

3740

"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.

3741

# Default is false.

3742

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3743

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3744

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3745

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3746

"A String",

3747

],

3748

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3749

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3750

"A String",

3751

],

3752

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3753

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3754

"A String",

3755

],

3756

"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.

3757

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3758

"A String",

3759

],

3760

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3761

},

3762

"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.

3763

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3764

"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.

3765

"httpStatus": 42, # The HTTP status code used to abort the request.

3766

# The value must be between 200 and 599 inclusive.

3767

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3768

# The value must be between 0.0 and 100.0 inclusive.

3769

},

3770

"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.

3771

"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.

3772

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3773

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3774

},

3775

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3776

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3777

},

3778

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3779

"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.

3780

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3781

},

3782

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3783

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3784

"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.

3785

# 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.

3786

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3787

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

3788

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3789

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3790

# - 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.

3791

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3792

# -

3793

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3794

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3795

# - 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.

3796

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3797

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3798

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3799

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3800

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3801

],

3802

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3803

"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.

3804

# If not specified, will use the largest timeout among all backend services associated with the route.

3805

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3806

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3807

},

3808

"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]

3809

# 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]

3810

"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]

3811

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3812

"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.

3813

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3814

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3815

"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.

3816

# 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.

3817

{ # 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

3818

"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.

3819

"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.

3820

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

3821

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3822

{ # Specification determining how headers are added to requests or responses.

3823

"headerName": "A String", # The name of the header.

3824

"headerValue": "A String", # The value of the header to add.

3825

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3826

# The default value is false.

3827

},

3828

],

3829

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3830

"A String",

3831

],

3832

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3833

{ # Specification determining how headers are added to requests or responses.

3834

"headerName": "A String", # The name of the header.

3835

"headerValue": "A String", # The value of the header to add.

3836

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3837

# The default value is false.

3838

},

3839

],

3840

"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) .

3845

# 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.

3846

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3847

},

3848

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3849

},

3850

"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.

3851

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3852

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3853

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

3854

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3855

# The value must be between 1 and 255 characters.

3856

"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.

3857

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3858

# The default is set to false.

3859

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3860

# 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.

3861

# The value must be between 1 and 1024 characters.

3862

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3863

# 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.

3864

# The value must be between 1 and 1024 characters.

3865

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3866

# Supported values are:

3867

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3868

# - FOUND, which corresponds to 302.

3869

# - SEE_OTHER which corresponds to 303.

3870

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3871

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3872

"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.

3873

# The default is set to false.

3874

},

3875

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3876

"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.

3877

#

3878

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3879

"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.

3880

# The headerAction specified here take effect after headerAction specified under pathMatcher.

3881

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3882

{ # Specification determining how headers are added to requests or responses.

3883

"headerName": "A String", # The name of the header.

3884

"headerValue": "A String", # The value of the header to add.

3885

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3886

# The default value is false.

3887

},

3888

],

3889

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3890

"A String",

3891

],

3892

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3893

{ # Specification determining how headers are added to requests or responses.

3894

"headerName": "A String", # The name of the header.

3895

"headerValue": "A String", # The value of the header to add.

3896

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3897

# The default value is false.

3898

},

3899

],

3900

"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.

3905

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3906

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3907

"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 ..

3908

"A String",

3909

],

3910

"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.

3911

},

3912

],

3913

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3914

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3915

"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.

3916

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3917

{ # 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.

3918

"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.

3919

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3920

# 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]

3921

"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

3922

"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.

3923

# Default is false.

3924

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3925

"A String",

3926

],

3927

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3928

"A String",

3929

],

3930

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3931

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3932

"A String",

3933

],

3934

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3935

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3936

"A String",

3937

],

3938

"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.

3939

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3940

"A String",

3941

],

3942

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3943

},

3944

"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.

3945

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

3946

"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.

3947

"httpStatus": 42, # The HTTP status code used to abort the request.

3948

# The value must be between 200 and 599 inclusive.

3949

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3950

# The value must be between 0.0 and 100.0 inclusive.

3951

},

3952

"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.

3953

"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.

3954

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3955

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3956

},

3957

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3958

# The value must be between 0.0 and 100.0 inclusive.

3959

},

3960

},

3961

"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.

3962

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3963

},

3964

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

3965

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3966

"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.

3967

# 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.

3968

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3969

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3970

},

3971

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3972

# - 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.

3973

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3974

# -

3975

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3976

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3977

# - 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.

3978

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3979

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3980

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3981

# - 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.

3986

# If not specified, will use the largest timeout among all backend services associated with the route.

3987

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3988

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3989

},

3990

"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]

3991

# 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]

3992

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3993

# The value must be between 1 and 255 characters.

3994

"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.

3995

# The value must be between 1 and 1024 characters.

3996

},

3997

"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.

3998

# 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.

3999

{ # 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

4000

"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.

4001

"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.

4002

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4003

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4004

{ # Specification determining how headers are added to requests or responses.

4005

"headerName": "A String", # The name of the header.

4006

"headerValue": "A String", # The value of the header to add.

4007

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4008

# The default value is false.

4009

},

4010

],

4011

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4012

"A String",

4013

],

4014

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4015

{ # Specification determining how headers are added to requests or responses.

4016

"headerName": "A String", # The name of the header.

4017

"headerValue": "A String", # The value of the header to add.

4018

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4019

# The default value is false.

4020

},

4021

],

4022

"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) .

4027

# 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.

4028

# 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:

4033

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4034

# - compute/v1/projects/project/global/backendServices/backendService

4035

# - 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.

4036

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4037

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4038

# - compute.backendBuckets.use

4039

# - compute.backendServices.use

4040

"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.

4041

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4042

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4043

# The value must be between 1 and 255 characters.

4044

"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.

4045

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4046

# The default is set to false.

4047

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4048

# 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.

4049

# The value must be between 1 and 1024 characters.

4050

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4051

# 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.

4052

# The value must be between 1 and 1024 characters.

4053

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4054

# Supported values are:

4055

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4056

# - FOUND, which corresponds to 302.

4057

# - SEE_OTHER which corresponds to 303.

4058

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4059

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4060

"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.

4061

# The default is set to false.

4062

},

4063

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4064

"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.

4065

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4066

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4067

{ # Specification determining how headers are added to requests or responses.

4068

"headerName": "A String", # The name of the header.

4069

"headerValue": "A String", # The value of the header to add.

4070

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4071

# The default value is false.

4072

},

4073

],

4074

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4075

"A String",

4076

],

4077

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4078

{ # Specification determining how headers are added to requests or responses.

4079

"headerName": "A String", # The name of the header.

4080

"headerValue": "A String", # The value of the header to add.

4081

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4082

# The default value is false.

4083

},

4084

],

4085

"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.

4090

"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.

4091

# 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.

4092

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4093

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4094

"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.

4095

"A String",

4096

],

4097

"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.

4098

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4099

# 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]

4100

"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

4101

"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.

4102

# Default is false.

4103

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4104

"A String",

4105

],

4106

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4107

"A String",

4108

],

4109

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4110

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4111

"A String",

4112

],

4113

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4114

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4115

"A String",

4116

],

4117

"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.

4118

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4119

"A String",

4120

],

4121

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4122

},

4123

"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.

4124

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4125

"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.

4126

"httpStatus": 42, # The HTTP status code used to abort the request.

4127

# The value must be between 200 and 599 inclusive.

4128

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4129

# The value must be between 0.0 and 100.0 inclusive.

4130

},

4131

"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.

4132

"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.

4133

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4134

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4135

},

4136

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4137

# The value must be between 0.0 and 100.0 inclusive.

4138

},

4139

},

4140

"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.

4141

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4142

},

4143

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4144

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4145

"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.

4146

# 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.

4147

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4148

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4149

},

4150

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4151

# - 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.

4152

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4153

# -

4154

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4155

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4156

# - 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.

4157

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4158

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4159

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4160

# - 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.

4165

# If not specified, will use the largest timeout among all backend services associated with the route.

4166

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4167

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4168

},

4169

"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]

4170

# 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]

4171

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4172

# The value must be between 1 and 255 characters.

4173

"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.

4174

# The value must be between 1 and 1024 characters.

4175

},

4176

"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.

4177

# 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.

4178

{ # 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

4179

"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.

4180

"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.

4181

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4182

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4183

{ # Specification determining how headers are added to requests or responses.

4184

"headerName": "A String", # The name of the header.

4185

"headerValue": "A String", # The value of the header to add.

4186

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4187

# The default value is false.

4188

},

4189

],

4190

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4191

"A String",

4192

],

4193

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4194

{ # Specification determining how headers are added to requests or responses.

4195

"headerName": "A String", # The name of the header.

4196

"headerValue": "A String", # The value of the header to add.

4197

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4198

# The default value is false.

4199

},

4200

],

4201

"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) .

4206

# 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.

4207

# 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.

4212

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4213

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4214

# If urlRedirect is specified, service or routeAction must not be set.

4215

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4216

# The value must be between 1 and 255 characters.

4217

"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.

4218

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4219

# The default is set to false.

4220

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4221

# 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.

4222

# The value must be between 1 and 1024 characters.

4223

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4224

# 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.

4225

# The value must be between 1 and 1024 characters.

4226

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4227

# Supported values are:

4228

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4229

# - FOUND, which corresponds to 302.

4230

# - SEE_OTHER which corresponds to 303.

4231

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4232

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4233

"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.

4234

# 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.

4239

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4240

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4241

"description": "A String", # The short description conveying the intent of this routeRule.

4242

# The description can have a maximum length of 1024 characters.

4243

"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.

4244

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

4245

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4246

{ # Specification determining how headers are added to requests or responses.

4247

"headerName": "A String", # The name of the header.

4248

"headerValue": "A String", # The value of the header to add.

4249

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4250

# The default value is false.

4251

},

4252

],

4253

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4254

"A String",

4255

],

4256

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4257

{ # Specification determining how headers are added to requests or responses.

4258

"headerName": "A String", # The name of the header.

4259

"headerValue": "A String", # The value of the header to add.

4260

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4261

# The default value is false.

4262

},

4263

],

4264

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

4269

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

4270

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

4271

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

4272

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

4273

},

4274

],

4275

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

4276

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

4277

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

4278

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

4279

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

4280

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

4285

"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.

4286

# fullPathMatch must be between 1 and 1024 characters.

4287

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4288

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4289

{ # matchRule criteria for request header matches.

4290

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4291

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4292

"headerName": "A String", # The name of the HTTP header to match.

4293

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4294

# For matching a request's method, use the headerName ":method".

4295

"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.

4296

# The default setting is false.

4297

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4298

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4299

"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.

4300

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4301

"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.

4302

# For example for a range [-5, 0]

4303

# - -3 will match.

4304

# - 0 will not match.

4305

# - 0.25 will not match.

4306

# - -3someString will not match.

4307

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4308

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4309

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4310

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4311

},

4312

"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

4313

# 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.

4314

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4315

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4316

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4317

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4318

},

4319

],

4320

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4321

# The default value is false.

4322

# ignoreCase must not be used with regexMatch.

4323

"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.

4324

# 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.

4325

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4326

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4327

{ # 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.

4328

# 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.

4329

# 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.

4330

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4331

# This list must not be empty and can have at the most 64 entries.

4332

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4333

"name": "A String", # Name of metadata label.

4334

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4335

"value": "A String", # The value of the label must match the specified value.

4336

# value can have a maximum length of 1024 characters.

4337

},

4338

],

4339

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4340

# Supported values are:

4341

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4342

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4343

},

4344

],

4345

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4346

# The value must be between 1 and 1024 characters.

4347

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4348

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

4349

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4350

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4351

# Only one of presentMatch, exactMatch or regexMatch must be set.

4352

"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.

4353

"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.

4354

# Only one of presentMatch, exactMatch or regexMatch must be set.

4355

"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

4356

# Only one of presentMatch, exactMatch or regexMatch must be set.

4357

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4358

},

4359

],

4360

"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

4361

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4362

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4363

},

4364

],

4365

"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.

4366

# 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.

4367

# 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.

4368

"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.

4369

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4370

"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

4371

"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.

4372

# Default is false.

4373

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4374

"A String",

4375

],

4376

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4377

"A String",

4378

],

4379

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4380

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4381

"A String",

4382

],

4383

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4384

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4385

"A String",

4386

],

4387

"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.

4388

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4389

"A String",

4390

],

4391

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4392

},

4393

"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.

4394

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4395

"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.

4396

"httpStatus": 42, # The HTTP status code used to abort the request.

4397

# The value must be between 200 and 599 inclusive.

4398

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4399

# The value must be between 0.0 and 100.0 inclusive.

4400

},

4401

"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.

4402

"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.

4403

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4404

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4405

},

4406

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4407

# The value must be between 0.0 and 100.0 inclusive.

4408

},

4409

},

4410

"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.

4411

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4412

},

4413

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4414

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4415

"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.

4416

# 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.

4417

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4418

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4419

},

4420

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4421

# - 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.

4422

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4423

# -

4424

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4425

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4426

# - 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.

4427

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4428

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4429

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4430

# - 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.

4435

# If not specified, will use the largest timeout among all backend services associated with the route.

4436

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4437

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4438

},

4439

"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]

4440

# 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]

4441

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4442

# The value must be between 1 and 255 characters.

4443

"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.

4444

# The value must be between 1 and 1024 characters.

4445

},

4446

"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.

4447

# 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.

4448

{ # 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

4449

"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.

4450

"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.

4451

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4452

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4453

{ # Specification determining how headers are added to requests or responses.

4454

"headerName": "A String", # The name of the header.

4455

"headerValue": "A String", # The value of the header to add.

4456

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4457

# The default value is false.

4458

},

4459

],

4460

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4461

"A String",

4462

],

4463

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4464

{ # Specification determining how headers are added to requests or responses.

4465

"headerName": "A String", # The name of the header.

4466

"headerValue": "A String", # The value of the header to add.

4467

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4468

# The default value is false.

4469

},

4470

],

4471

"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) .

4476

# 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.

4477

# 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.

4482

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4483

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4484

# If urlRedirect is specified, service or routeAction must not be set.

4485

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4486

# The value must be between 1 and 255 characters.

4487

"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.

4488

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4489

# The default is set to false.

4490

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4491

# 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.

4492

# The value must be between 1 and 1024 characters.

4493

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4494

# 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.

4495

# The value must be between 1 and 1024 characters.

4496

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4497

# Supported values are:

4498

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4499

# - FOUND, which corresponds to 302.

4500

# - SEE_OTHER which corresponds to 303.

4501

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4502

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4503

"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.

4504

# 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.

4511

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4512

"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.

4513

{ # Message for the expected URL mappings.

4514

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

4515

"description": "A String", # Description of this test case.

4516

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

4517

"host": "A String", # Host portion of the URL.

4518

"path": "A String", # Path portion of the URL.

4519

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

4520

},

4521

],

4522

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4523

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4524

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.

4525

4526

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.

4527

4528

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]

4529

4530

Returns:

4531

An object of the form:

4532

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4533

{ # Represents an Operation resource.

4534

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4535

# Google Compute Engine has three Operation resources:

4536

#

4537

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4538

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4539

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4540

#

4541

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4542

# - For global operations, use the `globalOperations` resource.

4543

# - For regional operations, use the `regionOperations` resource.

4544

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4545

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4546

# 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]

4547

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4548

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4549

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4550

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4551

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4552

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4553

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4554

"code": "A String", # [Output Only] The error type identifier for this error.

4555

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4556

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4557

},

4558

],

4559

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4560

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4561

"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.

4562

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4563

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4564

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4565

"name": "A String", # [Output Only] Name of the operation.

4566

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4567

"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.

4568

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4569

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4570

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

4571

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4572

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4573

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4574

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4575

"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.

4576

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4577

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4578

{

4579

"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.

4580

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4581

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4582

{

4583

"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).

4584

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4585

},

4586

],

4587

"message": "A String", # [Output Only] A human-readable description of the warning code.

4588

},

4589

],

4590

"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]

4595

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4596

<pre>Returns permissions that a caller has on the specified resource.

4597

4598

Args:

4599

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4600

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4601

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4602

The object takes the form of:

4603

4604

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4605

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

4606

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

4613

4614

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4615

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

4616

"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]

4622

<code class="details" id="update">update(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4623

<pre>Updates the specified UrlMap resource with the data included in the request.

4624

4625

Args:

4626

project: string, Project ID for this request. (required)

4627

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4628

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4629

The object takes the form of:

4630

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4631

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4632

#

4633

# Google Compute Engine has two URL Map resources:

4634

#

4635

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4636

#

4637

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4638

#

4639

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4640

#

4641

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4642

#

4643

# 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.

4644

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4645

"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.

4646

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4647

# 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]

4648

"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

4649

"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.

4650

# Default is false.

4651

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4652

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4653

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4654

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4655

"A String",

4656

],

4657

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4658

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4659

"A String",

4660

],

4661

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4662

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4663

"A String",

4664

],

4665

"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.

4666

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4667

"A String",

4668

],

4669

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4670

},

4671

"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.

4672

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4673

"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.

4674

"httpStatus": 42, # The HTTP status code used to abort the request.

4675

# The value must be between 200 and 599 inclusive.

4676

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4677

# The value must be between 0.0 and 100.0 inclusive.

4678

},

4679

"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.

4680

"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.

4681

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4682

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4683

},

4684

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4685

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4686

},

4687

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4688

"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.

4689

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4690

},

4691

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4692

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4693

"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.

4694

# 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.

4695

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4696

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

4697

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4698

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4699

# - 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.

4700

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4701

# -

4702

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4703

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4704

# - 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.

4705

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4706

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4707

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4708

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4709

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4710

],

4711

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4712

"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.

4713

# If not specified, will use the largest timeout among all backend services associated with the route.

4714

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4715

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4716

},

4717

"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]

4718

# 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]

4719

"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]

4720

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4721

"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.

4722

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4723

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4724

"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.

4725

# 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.

4726

{ # 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

4727

"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.

4728

"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.

4729

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4730

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4731

{ # Specification determining how headers are added to requests or responses.

4732

"headerName": "A String", # The name of the header.

4733

"headerValue": "A String", # The value of the header to add.

4734

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4735

# The default value is false.

4736

},

4737

],

4738

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4739

"A String",

4740

],

4741

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4742

{ # Specification determining how headers are added to requests or responses.

4743

"headerName": "A String", # The name of the header.

4744

"headerValue": "A String", # The value of the header to add.

4745

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4746

# The default value is false.

4747

},

4748

],

4749

"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) .

4754

# 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.

4755

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4756

},

4757

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4758

},

4759

"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.

4760

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4761

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4762

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4763

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4764

# The value must be between 1 and 255 characters.

4765

"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.

4766

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4767

# The default is set to false.

4768

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4769

# 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.

4770

# The value must be between 1 and 1024 characters.

4771

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4772

# 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.

4773

# The value must be between 1 and 1024 characters.

4774

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4775

# Supported values are:

4776

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4777

# - FOUND, which corresponds to 302.

4778

# - SEE_OTHER which corresponds to 303.

4779

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4780

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4781

"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.

4782

# The default is set to false.

4783

},

4784

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4785

"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.

4786

#

4787

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4788

"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.

4789

# The headerAction specified here take effect after headerAction specified under pathMatcher.

4790

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4791

{ # Specification determining how headers are added to requests or responses.

4792

"headerName": "A String", # The name of the header.

4793

"headerValue": "A String", # The value of the header to add.

4794

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4795

# The default value is false.

4796

},

4797

],

4798

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4799

"A String",

4800

],

4801

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4802

{ # Specification determining how headers are added to requests or responses.

4803

"headerName": "A String", # The name of the header.

4804

"headerValue": "A String", # The value of the header to add.

4805

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4806

# The default value is false.

4807

},

4808

],

4809

"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.

4814

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4815

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4816

"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 ..

4817

"A String",

4818

],

4819

"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.

4820

},

4821

],

4822

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4823

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4824

"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.

4825

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4826

{ # 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.

4827

"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.

4828

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4829

# 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]

4830

"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

4831

"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.

4832

# Default is false.

4833

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4834

"A String",

4835

],

4836

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4837

"A String",

4838

],

4839

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4840

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4841

"A String",

4842

],

4843

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4844

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4845

"A String",

4846

],

4847

"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.

4848

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4849

"A String",

4850

],

4851

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4852

},

4853

"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.

4854

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

4855

"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.

4856

"httpStatus": 42, # The HTTP status code used to abort the request.

4857

# The value must be between 200 and 599 inclusive.

4858

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4859

# The value must be between 0.0 and 100.0 inclusive.

4860

},

4861

"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.

4862

"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.

4863

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4864

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4865

},

4866

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4867

# The value must be between 0.0 and 100.0 inclusive.

4868

},

4869

},

4870

"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.

4871

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4872

},

4873

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

4874

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4875

"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.

4876

# 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.

4877

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4878

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4879

},

4880

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4881

# - 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.

4882

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4883

# -

4884

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4885

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4886

# - 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.

4887

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4888

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4889

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4890

# - 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.

4895

# If not specified, will use the largest timeout among all backend services associated with the route.

4896

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4897

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4898

},

4899

"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]

4900

# 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]

4901

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4902

# The value must be between 1 and 255 characters.

4903

"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.

4904

# The value must be between 1 and 1024 characters.

4905

},

4906

"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.

4907

# 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.

4908

{ # 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

4909

"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.

4910

"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.

4911

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

4912

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4913

{ # Specification determining how headers are added to requests or responses.

4914

"headerName": "A String", # The name of the header.

4915

"headerValue": "A String", # The value of the header to add.

4916

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4917

# The default value is false.

4918

},

4919

],

4920

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4921

"A String",

4922

],

4923

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4924

{ # Specification determining how headers are added to requests or responses.

4925

"headerName": "A String", # The name of the header.

4926

"headerValue": "A String", # The value of the header to add.

4927

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4928

# The default value is false.

4929

},

4930

],

4931

"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) .

4936

# 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.

4937

# 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:

4942

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4943

# - compute/v1/projects/project/global/backendServices/backendService

4944

# - 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.

4945

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4946

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4947

# - compute.backendBuckets.use

4948

# - compute.backendServices.use

4949

"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.

4950

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

4951

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4952

# The value must be between 1 and 255 characters.

4953

"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.

4954

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4955

# The default is set to false.

4956

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4957

# 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.

4958

# The value must be between 1 and 1024 characters.

4959

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4960

# 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.

4961

# The value must be between 1 and 1024 characters.

4962

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4963

# Supported values are:

4964

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4965

# - FOUND, which corresponds to 302.

4966

# - SEE_OTHER which corresponds to 303.

4967

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4968

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4969

"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.

4970

# The default is set to false.

4971

},

4972

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4973

"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.

4974

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

4975

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4976

{ # Specification determining how headers are added to requests or responses.

4977

"headerName": "A String", # The name of the header.

4978

"headerValue": "A String", # The value of the header to add.

4979

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4980

# The default value is false.

4981

},

4982

],

4983

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4984

"A String",

4985

],

4986

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4987

{ # Specification determining how headers are added to requests or responses.

4988

"headerName": "A String", # The name of the header.

4989

"headerValue": "A String", # The value of the header to add.

4990

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4991

# The default value is false.

4992

},

4993

],

4994

"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.

4999

"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.

5000

# 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.

5001

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5002

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5003

"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.

5004

"A String",

5005

],

5006

"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.

5007

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5008

# 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]

5009

"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

5010

"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.

5011

# Default is false.

5012

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5013

"A String",

5014

],

5015

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5016

"A String",

5017

],

5018

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5019

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5020

"A String",

5021

],

5022

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5023

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5024

"A String",

5025

],

5026

"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.

5027

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5028

"A String",

5029

],

5030

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5031

},

5032

"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.

5033

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5034

"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.

5035

"httpStatus": 42, # The HTTP status code used to abort the request.

5036

# The value must be between 200 and 599 inclusive.

5037

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5038

# The value must be between 0.0 and 100.0 inclusive.

5039

},

5040

"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.

5041

"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.

5042

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5043

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5044

},

5045

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5046

# The value must be between 0.0 and 100.0 inclusive.

5047

},

5048

},

5049

"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.

5050

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5051

},

5052

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5053

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5054

"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.

5055

# 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.

5056

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5057

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5058

},

5059

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5060

# - 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.

5061

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5062

# -

5063

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5064

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5065

# - 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.

5066

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5067

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5068

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5069

# - 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.

5074

# If not specified, will use the largest timeout among all backend services associated with the route.

5075

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5076

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5077

},

5078

"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]

5079

# 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]

5080

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5081

# The value must be between 1 and 255 characters.

5082

"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.

5083

# The value must be between 1 and 1024 characters.

5084

},

5085

"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.

5086

# 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.

5087

{ # 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

5088

"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.

5089

"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.

5090

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5091

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5092

{ # Specification determining how headers are added to requests or responses.

5093

"headerName": "A String", # The name of the header.

5094

"headerValue": "A String", # The value of the header to add.

5095

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5096

# The default value is false.

5097

},

5098

],

5099

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5100

"A String",

5101

],

5102

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5103

{ # Specification determining how headers are added to requests or responses.

5104

"headerName": "A String", # The name of the header.

5105

"headerValue": "A String", # The value of the header to add.

5106

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5107

# The default value is false.

5108

},

5109

],

5110

"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) .

5115

# 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.

5116

# 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.

5121

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5122

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5123

# If urlRedirect is specified, service or routeAction must not be set.

5124

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5125

# The value must be between 1 and 255 characters.

5126

"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.

5127

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5128

# The default is set to false.

5129

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5130

# 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.

5131

# The value must be between 1 and 1024 characters.

5132

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5133

# 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.

5134

# The value must be between 1 and 1024 characters.

5135

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5136

# Supported values are:

5137

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5138

# - FOUND, which corresponds to 302.

5139

# - SEE_OTHER which corresponds to 303.

5140

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5141

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5142

"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.

5143

# 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.

5148

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5149

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5150

"description": "A String", # The short description conveying the intent of this routeRule.

5151

# The description can have a maximum length of 1024 characters.

5152

"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.

5153

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

5154

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5155

{ # Specification determining how headers are added to requests or responses.

5156

"headerName": "A String", # The name of the header.

5157

"headerValue": "A String", # The value of the header to add.

5158

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5159

# The default value is false.

5160

},

5161

],

5162

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5163

"A String",

5164

],

5165

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5166

{ # Specification determining how headers are added to requests or responses.

5167

"headerName": "A String", # The name of the header.

5168

"headerValue": "A String", # The value of the header to add.

5169

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5170

# The default value is false.

5171

},

5172

],

5173

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

5178

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

5179

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

5180

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

5181

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

5182

},

5183

],

5184

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

5185

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

5186

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

5187

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

5188

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

5189

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5194

"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.

5195

# fullPathMatch must be between 1 and 1024 characters.

5196

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5197

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5198

{ # matchRule criteria for request header matches.

5199

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5200

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5201

"headerName": "A String", # The name of the HTTP header to match.

5202

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5203

# For matching a request's method, use the headerName ":method".

5204

"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.

5205

# The default setting is false.

5206

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5207

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5208

"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.

5209

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5210

"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.

5211

# For example for a range [-5, 0]

5212

# - -3 will match.

5213

# - 0 will not match.

5214

# - 0.25 will not match.

5215

# - -3someString will not match.

5216

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5217

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5218

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5219

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5220

},

5221

"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

5222

# 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.

5223

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5224

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5225

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5226

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5227

},

5228

],

5229

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5230

# The default value is false.

5231

# ignoreCase must not be used with regexMatch.

5232

"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.

5233

# 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.

5234

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5235

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5236

{ # 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.

5237

# 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.

5238

# 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.

5239

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5240

# This list must not be empty and can have at the most 64 entries.

5241

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5242

"name": "A String", # Name of metadata label.

5243

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5244

"value": "A String", # The value of the label must match the specified value.

5245

# value can have a maximum length of 1024 characters.

5246

},

5247

],

5248

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5249

# Supported values are:

5250

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5251

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5252

},

5253

],

5254

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5255

# The value must be between 1 and 1024 characters.

5256

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5257

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

5258

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5259

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5260

# Only one of presentMatch, exactMatch or regexMatch must be set.

5261

"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.

5262

"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.

5263

# Only one of presentMatch, exactMatch or regexMatch must be set.

5264

"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

5265

# Only one of presentMatch, exactMatch or regexMatch must be set.

5266

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5267

},

5268

],

5269

"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

5270

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5271

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5272

},

5273

],

5274

"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.

5275

# 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.

5276

# 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.

5277

"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.

5278

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5279

"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

5280

"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.

5281

# Default is false.

5282

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5283

"A String",

5284

],

5285

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5286

"A String",

5287

],

5288

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5289

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5290

"A String",

5291

],

5292

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5293

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5294

"A String",

5295

],

5296

"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.

5297

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5298

"A String",

5299

],

5300

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5301

},

5302

"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.

5303

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5304

"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.

5305

"httpStatus": 42, # The HTTP status code used to abort the request.

5306

# The value must be between 200 and 599 inclusive.

5307

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5308

# The value must be between 0.0 and 100.0 inclusive.

5309

},

5310

"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.

5311

"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.

5312

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5313

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5314

},

5315

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5316

# The value must be between 0.0 and 100.0 inclusive.

5317

},

5318

},

5319

"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.

5320

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5321

},

5322

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5323

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5324

"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.

5325

# 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.

5326

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5327

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5328

},

5329

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5330

# - 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.

5331

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5332

# -

5333

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5334

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5335

# - 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.

5336

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5337

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5338

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5339

# - 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.

5344

# If not specified, will use the largest timeout among all backend services associated with the route.

5345

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5346

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5347

},

5348

"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]

5349

# 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]

5350

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5351

# The value must be between 1 and 255 characters.

5352

"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.

5353

# The value must be between 1 and 1024 characters.

5354

},

5355

"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.

5356

# 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.

5357

{ # 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

5358

"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.

5359

"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.

5360

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5361

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5362

{ # Specification determining how headers are added to requests or responses.

5363

"headerName": "A String", # The name of the header.

5364

"headerValue": "A String", # The value of the header to add.

5365

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5366

# The default value is false.

5367

},

5368

],

5369

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5370

"A String",

5371

],

5372

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5373

{ # Specification determining how headers are added to requests or responses.

5374

"headerName": "A String", # The name of the header.

5375

"headerValue": "A String", # The value of the header to add.

5376

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5377

# The default value is false.

5378

},

5379

],

5380

"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) .

5385

# 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.

5386

# 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.

5391

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5392

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5393

# If urlRedirect is specified, service or routeAction must not be set.

5394

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5395

# The value must be between 1 and 255 characters.

5396

"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.

5397

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5398

# The default is set to false.

5399

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5400

# 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.

5401

# The value must be between 1 and 1024 characters.

5402

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5403

# 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.

5404

# The value must be between 1 and 1024 characters.

5405

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5406

# Supported values are:

5407

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5408

# - FOUND, which corresponds to 302.

5409

# - SEE_OTHER which corresponds to 303.

5410

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5411

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5412

"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.

5413

# 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.

5420

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5421

"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.

5422

{ # Message for the expected URL mappings.

5423

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

5424

"description": "A String", # Description of this test case.

5425

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

5426

"host": "A String", # Host portion of the URL.

5427

"path": "A String", # Path portion of the URL.

5428

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

5429

},

5430

],

5431

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5432

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5433

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.

5434

5435

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.

5436

5437

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]

5438

5439

Returns:

5440

An object of the form:

5441

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5442

{ # Represents an Operation resource.

5443

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5444

# Google Compute Engine has three Operation resources:

5445

#

5446

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5447

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5448

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5449

#

5450

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5451

# - For global operations, use the `globalOperations` resource.

5452

# - For regional operations, use the `regionOperations` resource.

5453

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5454

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5455

# 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]

5456

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5457

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5458

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5459

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5460

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5461

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5462

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5463

"code": "A String", # [Output Only] The error type identifier for this error.

5464

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5465

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5466

},

5467

],

5468

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5469

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5470

"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.

5471

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5472

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5473

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5474

"name": "A String", # [Output Only] Name of the operation.

5475

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5476

"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.

5477

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5478

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5479

"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.

5480

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5481

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5482

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5483

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5484

"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.

5485

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5486

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5487

{

5488

"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.

5489

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5490

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5491

{

5492

"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).

5493

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5494

},

5495

],

5496

"message": "A String", # [Output Only] A human-readable description of the warning code.

5497

},

5498

],

5499

"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]

5504

<code class="details" id="validate">validate(project, urlMap, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5505

<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.

5506

5507

Args:

5508

project: string, Project ID for this request. (required)

5509

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5510

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5511

The object takes the form of:

5512

5513

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5514

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

5515

#

5516

# Google Compute Engine has two URL Map resources:

5517

#

5518

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

5519

#

5520

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

5521

#

5522

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

5523

#

5524

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

5525

#

5526

# 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.

5527

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5528

"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.

5529

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5530

# 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]

5531

"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

5532

"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.

5533

# Default is false.

5534

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5535

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5536

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5537

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5538

"A String",

5539

],

5540

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5541

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5542

"A String",

5543

],

5544

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5545

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5546

"A String",

5547

],

5548

"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.

5549

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5550

"A String",

5551

],

5552

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5553

},

5554

"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.

5555

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5556

"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.

5557

"httpStatus": 42, # The HTTP status code used to abort the request.

5558

# The value must be between 200 and 599 inclusive.

5559

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5560

# The value must be between 0.0 and 100.0 inclusive.

5561

},

5562

"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.

5563

"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.

5564

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5565

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5566

},

5567

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5568

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5569

},

5570

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5571

"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.

5572

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5573

},

5574

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5575

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5576

"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.

5577

# 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.

5578

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5579

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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]

5580

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5581

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5582

# - 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.

5583

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5584

# -

5585

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5586

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5587

# - 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.

5588

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5589

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5590

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5591

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5592

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5593

],

5594

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5595

"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.

5596

# If not specified, will use the largest timeout among all backend services associated with the route.

5597

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5598

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5599

},

5600

"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]

5601

# 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]

5602

"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]

5603

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5604

"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.

5605

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5606

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5607

"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.

5608

# 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.

5609

{ # 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

5610

"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.

5611

"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.

5612

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5613

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5614

{ # Specification determining how headers are added to requests or responses.

5615

"headerName": "A String", # The name of the header.

5616

"headerValue": "A String", # The value of the header to add.

5617

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5618

# The default value is false.

5619

},

5620

],

5621

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5622

"A String",

5623

],

5624

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5625

{ # Specification determining how headers are added to requests or responses.

5626

"headerName": "A String", # The name of the header.

5627

"headerValue": "A String", # The value of the header to add.

5628

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5629

# The default value is false.

5630

},

5631

],

5632

"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) .

5637

# 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.

5638

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5639

},

5640

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5641

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5642

"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.

5643

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5644

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5645

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5646

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5647

# The value must be between 1 and 255 characters.

5648

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

5649

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5650

# The default is set to false.

5651

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5652

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

5653

# The value must be between 1 and 1024 characters.

5654

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5655

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

5656

# The value must be between 1 and 1024 characters.

5657

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5658

# Supported values are:

5659

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5660

# - FOUND, which corresponds to 302.

5661

# - SEE_OTHER which corresponds to 303.

5662

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5663

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5664

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

5665

# The default is set to false.

5666

},

5667

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5668

"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.

5669

#

5670

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

5671

"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.

5672

# The headerAction specified here take effect after headerAction specified under pathMatcher.

5673

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5674

{ # Specification determining how headers are added to requests or responses.

5675

"headerName": "A String", # The name of the header.

5676

"headerValue": "A String", # The value of the header to add.

5677

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5678

# The default value is false.

5679

},

5680

],

5681

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5682

"A String",

5683

],

5684

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5685

{ # Specification determining how headers are added to requests or responses.

5686

"headerName": "A String", # The name of the header.

5687

"headerValue": "A String", # The value of the header to add.

5688

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5689

# The default value is false.

5690

},

5691

],

5692

"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.

5697

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5698

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5699

"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 ..

5700

"A String",

5701

],

5702

"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.

5703

},

5704

],

5705

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5706

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5707

"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.

5708

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5709

{ # 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.

5710

"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.

5711

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5712

# 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]

5713

"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

5714

"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.

5715

# Default is false.

5716

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5717

"A String",

5718

],

5719

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5720

"A String",

5721

],

5722

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5723

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5724

"A String",

5725

],

5726

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5727

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5728

"A String",

5729

],

5730

"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.

5731

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5732

"A String",

5733

],

5734

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5735

},

5736

"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.

5737

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5738

"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.

5739

"httpStatus": 42, # The HTTP status code used to abort the request.

5740

# The value must be between 200 and 599 inclusive.

5741

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5742

# The value must be between 0.0 and 100.0 inclusive.

5743

},

5744

"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.

5745

"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.

5746

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5747

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5748

},

5749

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5750

# The value must be between 0.0 and 100.0 inclusive.

5751

},

5752

},

5753

"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.

5754

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5755

},

5756

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5757

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5758

"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.

5759

# 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.

5760

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5761

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5762

},

5763

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5764

# - 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.

5765

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5766

# -

5767

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5768

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5769

# - 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.

5770

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5771

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5772

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5773

# - 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.

5778

# If not specified, will use the largest timeout among all backend services associated with the route.

5779

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5780

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5781

},

5782

"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]

5783

# 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]

5784

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5785

# The value must be between 1 and 255 characters.

5786

"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.

5787

# The value must be between 1 and 1024 characters.

5788

},

5789

"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.

5790

# 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.

5791

{ # 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

5792

"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.

5793

"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.

5794

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5795

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5796

{ # Specification determining how headers are added to requests or responses.

5797

"headerName": "A String", # The name of the header.

5798

"headerValue": "A String", # The value of the header to add.

5799

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5800

# The default value is false.

5801

},

5802

],

5803

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5804

"A String",

5805

],

5806

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5807

{ # Specification determining how headers are added to requests or responses.

5808

"headerName": "A String", # The name of the header.

5809

"headerValue": "A String", # The value of the header to add.

5810

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5811

# The default value is false.

5812

},

5813

],

5814

"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) .

5819

# 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.

5820

# 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:

5825

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

5826

# - compute/v1/projects/project/global/backendServices/backendService

5827

# - 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.

5828

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5829

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

5830

# - compute.backendBuckets.use

5831

# - compute.backendServices.use

5832

"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.

5833

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

5834

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5835

# The value must be between 1 and 255 characters.

5836

"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.

5837

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5838

# The default is set to false.

5839

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5840

# 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.

5841

# The value must be between 1 and 1024 characters.

5842

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5843

# 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.

5844

# The value must be between 1 and 1024 characters.

5845

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5846

# Supported values are:

5847

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5848

# - FOUND, which corresponds to 302.

5849

# - SEE_OTHER which corresponds to 303.

5850

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5851

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5852

"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.

5853

# The default is set to false.

5854

},

5855

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5856

"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.

5857

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

5858

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5859

{ # Specification determining how headers are added to requests or responses.

5860

"headerName": "A String", # The name of the header.

5861

"headerValue": "A String", # The value of the header to add.

5862

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5863

# The default value is false.

5864

},

5865

],

5866

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5867

"A String",

5868

],

5869

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5870

{ # Specification determining how headers are added to requests or responses.

5871

"headerName": "A String", # The name of the header.

5872

"headerValue": "A String", # The value of the header to add.

5873

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5874

# The default value is false.

5875

},

5876

],

5877

"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.

5882

"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.

5883

# 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.

5884

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5885

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5886

"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.

5887

"A String",

5888

],

5889

"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.

5890

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5891

# 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]

5892

"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

5893

"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.

5894

# Default is false.

5895

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5896

"A String",

5897

],

5898

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5899

"A String",

5900

],

5901

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5902

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5903

"A String",

5904

],

5905

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5906

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5907

"A String",

5908

],

5909

"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.

5910

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5911

"A String",

5912

],

5913

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5914

},

5915

"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.

5916

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

5917

"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.

5918

"httpStatus": 42, # The HTTP status code used to abort the request.

5919

# The value must be between 200 and 599 inclusive.

5920

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5921

# The value must be between 0.0 and 100.0 inclusive.

5922

},

5923

"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.

5924

"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.

5925

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5926

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5927

},

5928

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5929

# The value must be between 0.0 and 100.0 inclusive.

5930

},

5931

},

5932

"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.

5933

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5934

},

5935

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

5936

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5937

"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.

5938

# 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.

5939

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5940

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5941

},

5942

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5943

# - 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.

5944

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5945

# -

5946

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5947

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5948

# - 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.

5949

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5950

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5951

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5952

# - 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.

5957

# If not specified, will use the largest timeout among all backend services associated with the route.

5958

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5959

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5960

},

5961

"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]

5962

# 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]

5963

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5964

# The value must be between 1 and 255 characters.

5965

"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.

5966

# The value must be between 1 and 1024 characters.

5967

},

5968

"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.

5969

# 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.

5970

{ # 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

5971

"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.

5972

"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.

5973

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

5974

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5975

{ # Specification determining how headers are added to requests or responses.

5976

"headerName": "A String", # The name of the header.

5977

"headerValue": "A String", # The value of the header to add.

5978

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5979

# The default value is false.

5980

},

5981

],

5982

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5983

"A String",

5984

],

5985

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5986

{ # Specification determining how headers are added to requests or responses.

5987

"headerName": "A String", # The name of the header.

5988

"headerValue": "A String", # The value of the header to add.

5989

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5990

# The default value is false.

5991

},

5992

],

5993

"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) .

5998

# 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.

5999

# 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.

6004

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6005

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

6006

# If urlRedirect is specified, service or routeAction must not be set.

6007

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6008

# The value must be between 1 and 255 characters.

6009

"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.

6010

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6011

# The default is set to false.

6012

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6013

# 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.

6014

# The value must be between 1 and 1024 characters.

6015

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6016

# 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.

6017

# The value must be between 1 and 1024 characters.

6018

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6019

# Supported values are:

6020

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6021

# - FOUND, which corresponds to 302.

6022

# - SEE_OTHER which corresponds to 303.

6023

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6024

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6025

"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.

6026

# 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.

6031

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

6032

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

6033

"description": "A String", # The short description conveying the intent of this routeRule.

6034

# The description can have a maximum length of 1024 characters.

6035

"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.

6036

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

6037

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6038

{ # Specification determining how headers are added to requests or responses.

6039

"headerName": "A String", # The name of the header.

6040

"headerValue": "A String", # The value of the header to add.

6041

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6042

# The default value is false.

6043

},

6044

],

6045

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6046

"A String",

6047

],

6048

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6049

{ # Specification determining how headers are added to requests or responses.

6050

"headerName": "A String", # The name of the header.

6051

"headerValue": "A String", # The value of the header to add.

6052

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6053

# The default value is false.

6054

},

6055

],

6056

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

6061

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

6062

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

6063

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

6064

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

6065

},

6066

],

6067

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

6068

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

6069

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

6070

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

6071

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

6072

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

},

],

"matchRules": [

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

6077

"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.

6078

# fullPathMatch must be between 1 and 1024 characters.

6079

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6080

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

6081

{ # matchRule criteria for request header matches.

6082

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

6083

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6084

"headerName": "A String", # The name of the HTTP header to match.

6085

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

6086

# For matching a request's method, use the headerName ":method".

6087

"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.

6088

# The default setting is false.

6089

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

6090

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6091

"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.

6092

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6093

"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.

6094

# For example for a range [-5, 0]

6095

# - -3 will match.

6096

# - 0 will not match.

6097

# - 0.25 will not match.

6098

# - -3someString will not match.

6099

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6100

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6101

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

6102

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

6103

},

6104

"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

6105

# 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.

6106

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6107

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6108

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

6109

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6110

},

6111

],

6112

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

6113

# The default value is false.

6114

# ignoreCase must not be used with regexMatch.

6115

"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.

6116

# 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.

6117

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

6118

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6119

{ # 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.

6120

# 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.

6121

# 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.

6122

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

6123

# This list must not be empty and can have at the most 64 entries.

6124

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

6125

"name": "A String", # Name of metadata label.

6126

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

6127

"value": "A String", # The value of the label must match the specified value.

6128

# value can have a maximum length of 1024 characters.

6129

},

6130

],

6131

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

6132

# Supported values are:

6133

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

6134

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

6135

},

6136

],

6137

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

6138

# The value must be between 1 and 1024 characters.

6139

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6140

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

6141

{ # HttpRouteRuleMatch criteria for a request's query parameter.

6142

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

6143

# Only one of presentMatch, exactMatch or regexMatch must be set.

6144

"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.

6145

"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.

6146

# Only one of presentMatch, exactMatch or regexMatch must be set.

6147

"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

6148

# Only one of presentMatch, exactMatch or regexMatch must be set.

6149

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

6150

},

6151

],

6152

"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

6153

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6154

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6155

},

6156

],

6157

"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.

6158

# 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.

6159

# 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.

6160

"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.

6161

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6162

"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

6163

"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.

6164

# Default is false.

6165

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6166

"A String",

6167

],

6168

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6169

"A String",

6170

],

6171

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6172

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6173

"A String",

6174

],

6175

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6176

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6177

"A String",

6178

],

6179

"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.

6180

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6181

"A String",

6182

],

6183

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6184

},

6185

"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.

6186

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

6187

"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.

6188

"httpStatus": 42, # The HTTP status code used to abort the request.

6189

# The value must be between 200 and 599 inclusive.

6190

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6191

# The value must be between 0.0 and 100.0 inclusive.

6192

},

6193

"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.

6194

"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.

6195

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6196

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6197

},

6198

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6199

# The value must be between 0.0 and 100.0 inclusive.

6200

},

6201

},

6202

"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.

6203

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6204

},

6205

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

6206

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6207

"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.

6208

# 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.

6209

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6210

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6211

},

6212

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6213

# - 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.

6214

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6215

# -

6216

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6217

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6218

# - 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.

6219

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6220

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6221

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6222

# - 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.

6227

# If not specified, will use the largest timeout among all backend services associated with the route.

6228

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6229

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6230

},

6231

"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]

6232

# 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]

6233

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6234

# The value must be between 1 and 255 characters.

6235

"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.

6236

# The value must be between 1 and 1024 characters.

6237

},

6238

"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.

6239

# 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.

6240

{ # 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

6241

"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.

6242

"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.

6243

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

6244

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6245

{ # Specification determining how headers are added to requests or responses.

6246

"headerName": "A String", # The name of the header.

6247

"headerValue": "A String", # The value of the header to add.

6248

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6249

# The default value is false.

6250

},

6251

],

6252

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6253

"A String",

6254

],

6255

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6256

{ # Specification determining how headers are added to requests or responses.

6257

"headerName": "A String", # The name of the header.

6258

"headerValue": "A String", # The value of the header to add.

6259

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6260

# The default value is false.

6261

},

6262

],

6263

"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) .

6268

# 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.

6269

# 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.

6274

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6275

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

6276

# If urlRedirect is specified, service or routeAction must not be set.

6277

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6278

# The value must be between 1 and 255 characters.

6279

"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.

6280

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6281

# The default is set to false.

6282

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6283

# 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.

6284

# The value must be between 1 and 1024 characters.

6285

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6286

# 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.

6287

# The value must be between 1 and 1024 characters.

6288

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6289

# Supported values are:

6290

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6291

# - FOUND, which corresponds to 302.

6292

# - SEE_OTHER which corresponds to 303.

6293

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6294

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6295

"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.

6296

# 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.

6303

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6304

"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.

6305

{ # Message for the expected URL mappings.

6306

"backendServiceWeight": 42, # The weight to use for the supplied host and path when using advanced routing rules that involve traffic splitting.

6307

"description": "A String", # Description of this test case.

6308

"expectedUrlRedirect": "A String", # The expected URL that should be redirected to for the host and path being tested.

6309

"host": "A String", # Host portion of the URL.

6310

"path": "A String", # Path portion of the URL.

6311

"service": "A String", # Expected BackendService resource the given URL should be mapped to.

6312

},

6313

],

6314

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}

Returns:

An object of the form:

6320

6321

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6322

"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.

6327

"testFailures": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6328

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6329

"actualService": "A String",

6330

"expectedService": "A String",

6331

"host": "A String",

6332

"path": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6333

},

6334

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6335

"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