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

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

[diff] [blame]

79

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

80

81

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

82

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

83

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<code><a href="#close">close()</a></code></p>

85

<p class="firstline">Close httplib2 connections.</p>

86

Bu Sun Kim

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

[diff] [blame]

87

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

Craig Citro

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

[diff] [blame]

88

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

89

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

Craig Citro

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

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

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

Craig Citro

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

[diff] [blame]

94

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

95

Dan O'Meara

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

[diff] [blame]

96

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

Jon Wayne Parrott

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

[diff] [blame]

97

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

98

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

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

Craig Citro

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

[diff] [blame]

100

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

101

102

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

103

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

104

Dan O'Meara

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

[diff] [blame]

105

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

106

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

Craig Citro

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

[diff] [blame]

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

ea3a5e1

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

[diff] [blame]

109

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

Craig Citro

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

[diff] [blame]

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>

Jon Wayne Parrott

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

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

Craig Citro

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

[diff] [blame]

113

<h3>Method Details</h3>

114

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

115

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

Dan O'Meara

2020-05-01 07:42:23 -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 `<`.

121

122

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

123

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.

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

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.

Dan O'Meara

2020-05-01 07:42:23 -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

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

155

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

156

#

157

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

158

#

Bu Sun Kim

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

[diff] [blame]

159

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

160

#

161

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

162

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

163

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

164

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

165

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

166

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

167

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

168

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

169

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

170

# Default is false.

171

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

172

"A String",

Dan O'Meara

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

[diff] [blame]

173

],

Bu Sun Kim

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

[diff] [blame]

174

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

175

"A String",

176

],

177

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

178

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

179

"A String",

180

],

181

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

182

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

183

"A String",

184

],

185

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

186

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

187

"A String",

188

],

189

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

190

},

191

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

192

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

193

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

194

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

195

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

196

# The value must be between 200 and 599 inclusive.

197

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

198

# The value must be between 0.0 and 100.0 inclusive.

199

},

200

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

201

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

202

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

203

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

204

},

205

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

206

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

207

},

208

},

Bu Sun Kim

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

[diff] [blame]

209

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

210

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

211

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

212

},

213

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

214

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

215

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

216

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

217

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

218

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

219

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

Dan O'Meara

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

[diff] [blame]

220

},

Bu Sun Kim

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

[diff] [blame]

221

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

222

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

223

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

224

# -

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

"A String",

Dan O'Meara

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

[diff] [blame]

233

],

234

},

Bu Sun Kim

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

[diff] [blame]

235

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

236

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

237

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

},

241

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

242

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

243

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

244

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

Dan O'Meara

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

[diff] [blame]

245

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

246

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

247

# The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

248

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

249

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

250

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

Bu Sun Kim

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

[diff] [blame]

251

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

252

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

253

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

254

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

255

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

256

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

257

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

258

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

259

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

260

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

261

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

262

# The default value is false.

263

},

264

],

265

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

266

"A String",

267

],

268

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

269

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

270

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

271

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

272

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

273

# The default value is false.

274

},

275

],

276

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

281

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

282

# The value must be between 0 and 1000

Dan O'Meara

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

[diff] [blame]

283

},

284

],

Dan O'Meara

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

[diff] [blame]

285

},

Bu Sun Kim

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

[diff] [blame]

286

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

287

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

288

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

291

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

292

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

293

# The value must be between 1 and 255 characters.

294

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

295

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

296

# The default is set to false.

297

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

298

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

299

# The value must be between 1 and 1024 characters.

300

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

301

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

302

# The value must be between 1 and 1024 characters.

303

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

304

# Supported values are:

305

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

306

# - FOUND, which corresponds to 302.

307

# - SEE_OTHER which corresponds to 303.

308

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

309

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

310

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

311

# The default is set to false.

312

},

313

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

314

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

315

#

316

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

317

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

318

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

319

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

320

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

321

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

322

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

323

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

324

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

325

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

326

# The default value is false.

327

},

328

],

329

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

330

"A String",

331

],

332

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

333

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

334

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

335

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

336

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

337

# The default value is false.

338

},

339

],

340

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

345

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

346

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

347

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

348

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

349

"A String",

350

],

351

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

352

},

353

],

354

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

355

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

356

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

357

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

358

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

359

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

360

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

361

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

362

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

363

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

364

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

365

# Default is false.

366

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

367

"A String",

368

],

369

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

370

"A String",

371

],

372

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

373

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

374

"A String",

375

],

376

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

377

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

378

"A String",

379

],

380

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

381

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

382

"A String",

383

],

384

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

385

},

386

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

387

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

388

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

389

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

390

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

391

# The value must be between 200 and 599 inclusive.

392

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

393

# The value must be between 0.0 and 100.0 inclusive.

394

},

395

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

396

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

397

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

398

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

399

},

400

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

401

# The value must be between 0.0 and 100.0 inclusive.

402

},

403

},

404

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

405

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

406

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

407

},

408

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

409

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

412

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

413

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

414

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

415

},

416

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

417

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

418

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

419

# -

420

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

421

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

422

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

423

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

424

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

425

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

426

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

431

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

432

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

433

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

434

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

435

},

436

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

437

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

438

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

439

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

440

# The value must be between 1 and 255 characters.

441

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

442

# The value must be between 1 and 1024 characters.

443

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

444

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

445

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

Bu Sun Kim

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

[diff] [blame]

446

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

447

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

448

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

449

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

450

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

451

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

452

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

453

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

454

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

455

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

456

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

457

# The default value is false.

458

},

459

],

460

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

461

"A String",

462

],

463

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

464

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

465

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

466

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

467

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

468

# The default value is false.

469

},

470

],

471

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

476

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

477

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

482

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

483

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

484

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

485

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

486

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

487

# - compute.backendBuckets.use

488

# - compute.backendServices.use

489

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

490

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

491

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

492

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

493

# The value must be between 1 and 255 characters.

494

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

495

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

496

# The default is set to false.

497

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

498

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

499

# The value must be between 1 and 1024 characters.

500

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

501

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

502

# The value must be between 1 and 1024 characters.

503

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

504

# Supported values are:

505

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

506

# - FOUND, which corresponds to 302.

507

# - SEE_OTHER which corresponds to 303.

508

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

509

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

510

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

511

# The default is set to false.

512

},

513

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

514

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

515

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

516

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

517

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

518

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

519

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

520

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

521

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

522

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

523

# The default value is false.

524

},

525

],

526

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

527

"A String",

528

],

529

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

530

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

531

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

532

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

533

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

534

# The default value is false.

535

},

536

],

537

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

542

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

543

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

544

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

545

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

546

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

547

"A String",

548

],

549

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

550

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

551

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

552

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

553

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

554

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

555

# Default is false.

556

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

557

"A String",

558

],

559

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

560

"A String",

561

],

562

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

563

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

564

"A String",

565

],

566

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

567

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

568

"A String",

569

],

570

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

571

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

572

"A String",

573

],

574

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

575

},

576

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

577

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

578

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

579

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

580

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

581

# The value must be between 200 and 599 inclusive.

582

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

583

# The value must be between 0.0 and 100.0 inclusive.

584

},

585

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

586

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

587

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

588

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

589

},

590

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

591

# The value must be between 0.0 and 100.0 inclusive.

592

},

593

},

594

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

595

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

596

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

597

},

598

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

599

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

600

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

601

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

602

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

603

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

604

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

605

},

606

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

607

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

608

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

609

# -

610

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

611

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

612

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

613

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

614

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

615

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

616

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

621

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

622

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

623

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

624

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

625

},

626

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

627

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

628

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

629

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

630

# The value must be between 1 and 255 characters.

631

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

632

# The value must be between 1 and 1024 characters.

633

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

634

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

635

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

Bu Sun Kim

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

[diff] [blame]

636

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

637

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

638

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

639

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

640

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

641

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

642

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

643

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

644

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

645

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

646

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

647

# The default value is false.

648

},

649

],

650

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

651

"A String",

652

],

653

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

654

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

655

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

656

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

657

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

658

# The default value is false.

659

},

660

],

661

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

666

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

667

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

672

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

673

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

674

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

675

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

676

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

677

# The value must be between 1 and 255 characters.

678

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

679

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

680

# The default is set to false.

681

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

682

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

683

# The value must be between 1 and 1024 characters.

684

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

685

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

686

# The value must be between 1 and 1024 characters.

687

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

688

# Supported values are:

689

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

690

# - FOUND, which corresponds to 302.

691

# - SEE_OTHER which corresponds to 303.

692

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

693

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

694

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

695

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

700

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

701

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

702

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

703

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

704

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

705

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

706

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

707

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

708

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

709

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

710

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

711

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

712

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

713

# The default value is false.

714

},

715

],

716

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

717

"A String",

718

],

719

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

720

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

721

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

722

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

723

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

724

# The default value is false.

725

},

726

],

727

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

728

"A String",

729

],

730

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

731

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

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

[diff] [blame]

732

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

733

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

734

# fullPathMatch must be between 1 and 1024 characters.

735

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

736

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

737

{ # matchRule criteria for request header matches.

738

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

739

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

740

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

741

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

742

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

743

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

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

[diff] [blame]

744

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

745

# The default setting is false.

746

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

747

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

748

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

749

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

750

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

751

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

752

# - -3 will match.

753

# - 0 will not match.

754

# - 0.25 will not match.

755

# - -3someString will not match.

756

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

757

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

758

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

759

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

760

},

761

"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

762

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

763

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

764

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

765

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

766

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

767

},

768

],

769

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

770

# The default value is false.

771

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

772

# Not supported when the URL map is bound to target gRPC proxy.

773

"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. When there is a match, the relevant routing configuration is made available to those proxies.

774

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

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

[diff] [blame]

775

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

776

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

777

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

# value can have a maximum length of 1024 characters.

788

},

789

],

790

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

791

# Supported values are:

792

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

793

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

794

},

795

],

796

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

797

# The value must be between 1 and 1024 characters.

798

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

799

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

800

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

801

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

802

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

803

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

804

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

805

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

806

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

807

"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

808

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

809

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

810

},

811

],

812

"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

813

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

814

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

815

},

816

],

817

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

818

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

819

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

820

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

821

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

822

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

Bu Sun Kim

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

[diff] [blame]

823

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

824

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

825

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

826

# Default is false.

827

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

828

"A String",

829

],

830

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

831

"A String",

832

],

833

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

834

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

835

"A String",

836

],

837

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

838

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

839

"A String",

840

],

841

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

842

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

843

"A String",

844

],

845

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

846

},

847

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

848

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

849

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

850

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

851

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

852

# The value must be between 200 and 599 inclusive.

853

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

854

# The value must be between 0.0 and 100.0 inclusive.

855

},

856

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

857

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

858

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

859

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

860

},

861

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

862

# The value must be between 0.0 and 100.0 inclusive.

863

},

864

},

865

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

866

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

867

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

868

},

869

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

870

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

871

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

872

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

873

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

874

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

875

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

876

},

877

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

878

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

879

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

880

# -

881

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

882

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

883

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

884

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

885

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

886

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

887

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

892

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

893

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

894

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

895

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

896

},

897

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

898

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

899

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

900

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

901

# The value must be between 1 and 255 characters.

902

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

903

# The value must be between 1 and 1024 characters.

904

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

905

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

906

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

Bu Sun Kim

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

[diff] [blame]

907

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

908

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

909

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

910

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

911

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

912

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

913

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

914

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

915

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

916

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

917

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

918

# The default value is false.

919

},

920

],

921

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

922

"A String",

923

],

924

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

925

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

926

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

927

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

928

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

929

# The default value is false.

930

},

931

],

932

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

937

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

938

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

943

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

944

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

945

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

946

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

947

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

948

# The value must be between 1 and 255 characters.

949

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

950

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

951

# The default is set to false.

952

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

953

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

954

# The value must be between 1 and 1024 characters.

955

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

956

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

957

# The value must be between 1 and 1024 characters.

958

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

959

# Supported values are:

960

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

961

# - FOUND, which corresponds to 302.

962

# - SEE_OTHER which corresponds to 303.

963

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

964

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

965

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

966

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

973

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

974

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

975

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

976

{ # Message for the expected URL mappings.

977

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

978

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

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

[diff] [blame]

979

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

980

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

981

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

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

[diff] [blame]

982

},

983

],

984

},

Dan O'Meara

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

[diff] [blame]

985

],

Bu Sun Kim

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

[diff] [blame]

986

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

987

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

988

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

989

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

Dan O'Meara

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

[diff] [blame]

990

{

Bu Sun Kim

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

[diff] [blame]

991

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

992

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

Dan O'Meara

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

[diff] [blame]

993

},

994

],

Bu Sun Kim

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

[diff] [blame]

995

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

Dan O'Meara

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

[diff] [blame]

996

},

997

},

998

},

Bu Sun Kim

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

[diff] [blame]

999

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

1000

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

1001

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1002

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

1003

"A String",

1004

],

Bu Sun Kim

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

[diff] [blame]

1005

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

1006

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

1007

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

1008

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

Dan O'Meara

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

[diff] [blame]

1009

{

Bu Sun Kim

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

[diff] [blame]

1010

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

1011

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

Dan O'Meara

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

[diff] [blame]

1012

},

1013

],

Bu Sun Kim

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

[diff] [blame]

1014

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

Dan O'Meara

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

[diff] [blame]

1015

},

Dan O'Meara

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

[diff] [blame]

}</pre>

</div>

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

1021

<pre>Retrieves the next page of results.

1022

1023

Args:

1024

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

1025

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

1026

1027

Returns:

Bu Sun Kim

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

[diff] [blame]

1028

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

Dan O'Meara

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

[diff] [blame]

1029

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

</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1034

<code class="details" id="close">close()</code>

1035

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1039

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

Craig Citro

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

[diff] [blame]

1040

<pre>Deletes the specified UrlMap resource.

1041

1042

Args:

Jon Wayne Parrott

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

[diff] [blame]

1043

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

Craig Citro

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

[diff] [blame]

1044

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

Bu Sun Kim

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

[diff] [blame]

1045

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.

1046

1047

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.

1048

1049

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

Craig Citro

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

[diff] [blame]

1050

1051

Returns:

1052

An object of the form:

1053

Bu Sun Kim

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

[diff] [blame]

1054

{ # Represents an Operation resource.

1055

#

Dan O'Meara

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

[diff] [blame]

1056

# Google Compute Engine has three Operation resources:

1057

#

1058

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

1059

#

Bu Sun Kim

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

[diff] [blame]

1060

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

1061

#

1062

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1063

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

1064

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

1065

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

Bu Sun Kim

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

[diff] [blame]

1066

#

Dan O'Meara

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

[diff] [blame]

1067

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

1068

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

1069

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

1070

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

1071

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

1072

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

1073

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

Craig Citro

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

[diff] [blame]

1074

{

Bu Sun Kim

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

[diff] [blame]

1075

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

1076

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

1077

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

Craig Citro

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

[diff] [blame]

1078

},

1079

],

1080

},

Bu Sun Kim

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

[diff] [blame]

1081

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

1082

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

1083

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

1084

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

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

1094

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

1095

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

1096

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

1097

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

1098

{

1099

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

1100

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

1101

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

1102

{

1103

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

1104

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

1105

},

1106

],

1107

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

1108

},

1109

],

1110

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

Craig Citro

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

1116

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

Craig Citro

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

[diff] [blame]

1117

1118

Args:

Jon Wayne Parrott

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

[diff] [blame]

1119

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

Craig Citro

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

[diff] [blame]

1120

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

1121

1122

Returns:

1123

An object of the form:

1124

Dan O'Meara

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

[diff] [blame]

1125

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1126

#

1127

# Google Compute Engine has two URL Map resources:

1128

#

1129

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

1130

#

1131

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

1132

#

1133

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

1134

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1135

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

1136

#

1137

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

1138

#

Bu Sun Kim

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

[diff] [blame]

1139

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

1140

#

1141

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

1142

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

1143

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

1144

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

1145

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1146

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1147

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1148

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

1149

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

1150

# Default is false.

1151

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

1152

"A String",

Dan O'Meara

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

[diff] [blame]

1153

],

Bu Sun Kim

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

[diff] [blame]

1154

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

1155

"A String",

1156

],

1157

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

1158

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

1159

"A String",

1160

],

1161

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

1162

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

1163

"A String",

1164

],

1165

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

1166

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

1167

"A String",

1168

],

1169

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

1170

},

1171

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

1172

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1173

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1174

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

1175

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

1176

# The value must be between 200 and 599 inclusive.

1177

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

1178

# The value must be between 0.0 and 100.0 inclusive.

1179

},

1180

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

1181

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

1182

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

1183

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

1184

},

1185

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

1186

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

1187

},

1188

},

Bu Sun Kim

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

[diff] [blame]

1189

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1190

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1191

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

1192

},

1193

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1194

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1195

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

1196

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

1197

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

1198

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

1199

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

Craig Citro

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

[diff] [blame]

1200

},

Bu Sun Kim

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

[diff] [blame]

1201

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

1202

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

1203

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

1204

# -

1205

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

1206

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

1207

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

1208

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

1209

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

1210

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

1211

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

1212

"A String",

Dan O'Meara

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

[diff] [blame]

1213

],

1214

},

Bu Sun Kim

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

[diff] [blame]

1215

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

1216

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1217

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1218

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

1219

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

1220

},

1221

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

1222

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1223

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1224

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

Dan O'Meara

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

[diff] [blame]

1225

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

1226

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

1227

# The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

1228

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1229

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

1230

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

Bu Sun Kim

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

[diff] [blame]

1231

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

1232

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

1233

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

1234

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1235

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

1236

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1237

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

1238

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

1239

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

1240

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

1241

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

1242

# The default value is false.

1243

},

1244

],

1245

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

1246

"A String",

1247

],

1248

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

1249

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

1250

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

1251

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

1252

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

1253

# The default value is false.

1254

},

1255

],

1256

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

1261

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

1262

# The value must be between 0 and 1000

Craig Citro

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

[diff] [blame]

1263

},

1264

],

Bu Sun Kim

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

[diff] [blame]

1265

},

1266

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

1267

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1268

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1269

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

1270

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1271

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

1272

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

1273

# The value must be between 1 and 255 characters.

1274

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

1275

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

1276

# The default is set to false.

1277

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

1278

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

1279

# The value must be between 1 and 1024 characters.

1280

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

1281

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

1282

# The value must be between 1 and 1024 characters.

1283

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

1284

# Supported values are:

1285

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1286

# - FOUND, which corresponds to 302.

1287

# - SEE_OTHER which corresponds to 303.

1288

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1289

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1290

"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.

1291

# The default is set to false.

1292

},

1293

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1294

"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.

1295

#

1296

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

1297

"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.

1298

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1299

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1300

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1301

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1302

{ # Specification determining how headers are added to requests or responses.

1303

"headerName": "A String", # The name of the header.

1304

"headerValue": "A String", # The value of the header to add.

1305

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1306

# The default value is false.

1307

},

1308

],

1309

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1310

"A String",

1311

],

1312

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1313

{ # Specification determining how headers are added to requests or responses.

1314

"headerName": "A String", # The name of the header.

1315

"headerValue": "A String", # The value of the header to add.

1316

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1317

# The default value is false.

1318

},

1319

],

1320

"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.

1325

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

1326

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1327

"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 ..

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1328

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1329

"A String",

1330

],

1331

"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.

1332

},

1333

],

1334

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1335

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

1336

"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.

1337

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

1338

{ # 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.

1339

"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.

1340

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1341

# 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]

1342

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1343

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1344

"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.

1345

# Default is false.

1346

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1347

"A String",

1348

],

1349

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1350

"A String",

1351

],

1352

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1353

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1354

"A String",

1355

],

1356

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1357

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1358

"A String",

1359

],

1360

"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.

1361

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1362

"A String",

1363

],

1364

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1365

},

1366

"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.

1367

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1368

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1369

"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.

1370

"httpStatus": 42, # The HTTP status code used to abort the request.

1371

# The value must be between 200 and 599 inclusive.

1372

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1373

# The value must be between 0.0 and 100.0 inclusive.

1374

},

1375

"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.

1376

"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.

1377

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1378

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1379

},

1380

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1381

# The value must be between 0.0 and 100.0 inclusive.

1382

},

1383

},

1384

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1385

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1386

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1387

},

1388

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1389

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1390

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1391

"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.

1392

# 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.

1393

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1394

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1395

},

1396

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1397

# - 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.

1398

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1399

# -

1400

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1401

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1402

# - 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.

1403

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1404

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1405

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1406

# - 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.

1411

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1412

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1413

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1414

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1415

},

1416

"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]

1417

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1418

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1419

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1420

# The value must be between 1 and 255 characters.

1421

"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.

1422

# The value must be between 1 and 1024 characters.

1423

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1424

"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-zero number.

1425

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1426

{ # 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

1427

"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.

1428

"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.

1429

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1430

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1431

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1432

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1433

{ # Specification determining how headers are added to requests or responses.

1434

"headerName": "A String", # The name of the header.

1435

"headerValue": "A String", # The value of the header to add.

1436

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1437

# The default value is false.

1438

},

1439

],

1440

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1441

"A String",

1442

],

1443

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1444

{ # Specification determining how headers are added to requests or responses.

1445

"headerName": "A String", # The name of the header.

1446

"headerValue": "A String", # The value of the header to add.

1447

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1448

# The default value is false.

1449

},

1450

],

1451

"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) .

1456

# 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.

1457

# 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:

1462

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

1463

# - compute/v1/projects/project/global/backendServices/backendService

1464

# - 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.

1465

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1466

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

1467

# - compute.backendBuckets.use

1468

# - compute.backendServices.use

1469

"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.

1470

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1471

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1472

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1473

# The value must be between 1 and 255 characters.

1474

"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.

1475

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1476

# The default is set to false.

1477

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1478

# 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.

1479

# The value must be between 1 and 1024 characters.

1480

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1481

# 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.

1482

# The value must be between 1 and 1024 characters.

1483

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1484

# Supported values are:

1485

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1486

# - FOUND, which corresponds to 302.

1487

# - SEE_OTHER which corresponds to 303.

1488

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1489

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1490

"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.

1491

# The default is set to false.

1492

},

1493

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1494

"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.

1495

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1496

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1497

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1498

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1499

{ # Specification determining how headers are added to requests or responses.

1500

"headerName": "A String", # The name of the header.

1501

"headerValue": "A String", # The value of the header to add.

1502

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1503

# The default value is false.

1504

},

1505

],

1506

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1507

"A String",

1508

],

1509

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1510

{ # Specification determining how headers are added to requests or responses.

1511

"headerName": "A String", # The name of the header.

1512

"headerValue": "A String", # The value of the header to add.

1513

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1514

# The default value is false.

1515

},

1516

],

1517

"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.

1522

"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.

1523

# 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.

1524

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1525

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1526

"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.

1527

"A String",

1528

],

1529

"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.

1530

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1531

# 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]

1532

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1533

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1534

"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.

1535

# Default is false.

1536

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1537

"A String",

1538

],

1539

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1540

"A String",

1541

],

1542

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1543

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1544

"A String",

1545

],

1546

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1547

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1548

"A String",

1549

],

1550

"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.

1551

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1552

"A String",

1553

],

1554

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1555

},

1556

"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.

1557

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1558

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1559

"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.

1560

"httpStatus": 42, # The HTTP status code used to abort the request.

1561

# The value must be between 200 and 599 inclusive.

1562

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1563

# The value must be between 0.0 and 100.0 inclusive.

1564

},

1565

"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.

1566

"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.

1567

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1568

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1569

},

1570

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1571

# The value must be between 0.0 and 100.0 inclusive.

1572

},

1573

},

1574

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1575

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1576

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1577

},

1578

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1579

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1580

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1581

"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.

1582

# 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.

1583

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1584

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1585

},

1586

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1587

# - 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.

1588

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1589

# -

1590

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1591

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1592

# - 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.

1593

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1594

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1595

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1596

# - 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.

1601

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1602

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1603

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1604

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1605

},

1606

"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]

1607

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1608

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1609

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1610

# The value must be between 1 and 255 characters.

1611

"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.

1612

# The value must be between 1 and 1024 characters.

1613

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1614

"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-zero number.

1615

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1616

{ # 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

1617

"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.

1618

"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.

1619

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1620

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1621

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1622

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1623

{ # Specification determining how headers are added to requests or responses.

1624

"headerName": "A String", # The name of the header.

1625

"headerValue": "A String", # The value of the header to add.

1626

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1627

# The default value is false.

1628

},

1629

],

1630

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1631

"A String",

1632

],

1633

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1634

{ # Specification determining how headers are added to requests or responses.

1635

"headerName": "A String", # The name of the header.

1636

"headerValue": "A String", # The value of the header to add.

1637

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1638

# The default value is false.

1639

},

1640

],

1641

"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) .

1646

# 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.

1647

# 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.

1652

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1653

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1654

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1655

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1656

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1657

# The value must be between 1 and 255 characters.

1658

"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.

1659

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1660

# The default is set to false.

1661

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1662

# 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.

1663

# The value must be between 1 and 1024 characters.

1664

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1665

# 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.

1666

# The value must be between 1 and 1024 characters.

1667

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1668

# Supported values are:

1669

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1670

# - FOUND, which corresponds to 302.

1671

# - SEE_OTHER which corresponds to 303.

1672

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1673

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1674

"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.

1675

# 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.

1680

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1681

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1682

"description": "A String", # The short description conveying the intent of this routeRule.

1683

# The description can have a maximum length of 1024 characters.

1684

"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.

1685

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1686

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1687

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1688

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1689

{ # Specification determining how headers are added to requests or responses.

1690

"headerName": "A String", # The name of the header.

1691

"headerValue": "A String", # The value of the header to add.

1692

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1693

# The default value is false.

1694

},

1695

],

1696

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1697

"A String",

1698

],

1699

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1700

{ # Specification determining how headers are added to requests or responses.

1701

"headerName": "A String", # The name of the header.

1702

"headerValue": "A String", # The value of the header to add.

1703

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1704

# The default value is false.

1705

},

1706

],

1707

"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.

1708

"A String",

1709

],

1710

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1711

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1712

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

1713

"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.

1714

# fullPathMatch must be between 1 and 1024 characters.

1715

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1716

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1717

{ # matchRule criteria for request header matches.

1718

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1719

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1720

"headerName": "A String", # The name of the HTTP header to match.

1721

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1722

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1723

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1724

"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.

1725

# The default setting is false.

1726

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1727

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1728

"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.

1729

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1730

"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.

1731

# For example for a range [-5, 0]

1732

# - -3 will match.

1733

# - 0 will not match.

1734

# - 0.25 will not match.

1735

# - -3someString will not match.

1736

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1737

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1738

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1739

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1740

},

1741

"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

1742

# 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.

1743

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1744

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1745

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1746

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1747

},

1748

],

1749

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1750

# The default value is false.

1751

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1752

# Not supported when the URL map is bound to target gRPC proxy.

1753

"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. When there is a match, the relevant routing configuration is made available to those proxies.

1754

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1756

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1757

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1758

{ # 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.

1759

# 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.

1760

# 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.

1761

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1762

# This list must not be empty and can have at the most 64 entries.

1763

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1764

"name": "A String", # Name of metadata label.

1765

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1766

"value": "A String", # The value of the label must match the specified value.

1767

# value can have a maximum length of 1024 characters.

1768

},

1769

],

1770

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1771

# Supported values are:

1772

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1773

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1774

},

1775

],

1776

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1777

# The value must be between 1 and 1024 characters.

1778

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1779

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1780

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1781

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1782

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1783

# Only one of presentMatch, exactMatch or regexMatch must be set.

1784

"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.

1785

"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.

1786

# Only one of presentMatch, exactMatch or regexMatch must be set.

1787

"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

1788

# Only one of presentMatch, exactMatch or regexMatch must be set.

1789

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1790

},

1791

],

1792

"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

1793

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1794

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1795

},

1796

],

1797

"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.

1798

# 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.

1799

# 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.

1800

"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.

1801

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1802

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1803

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1804

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1805

"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.

1806

# Default is false.

1807

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1808

"A String",

1809

],

1810

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1811

"A String",

1812

],

1813

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1814

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1815

"A String",

1816

],

1817

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1818

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1819

"A String",

1820

],

1821

"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.

1822

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1823

"A String",

1824

],

1825

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1826

},

1827

"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.

1828

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1829

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1830

"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.

1831

"httpStatus": 42, # The HTTP status code used to abort the request.

1832

# The value must be between 200 and 599 inclusive.

1833

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1834

# The value must be between 0.0 and 100.0 inclusive.

1835

},

1836

"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.

1837

"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.

1838

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1839

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1840

},

1841

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1842

# The value must be between 0.0 and 100.0 inclusive.

1843

},

1844

},

1845

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1846

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1847

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1848

},

1849

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1850

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1851

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1852

"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.

1853

# 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.

1854

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1855

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1856

},

1857

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1858

# - 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.

1859

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1860

# -

1861

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1862

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1863

# - 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.

1864

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1865

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1866

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1867

# - 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.

1872

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1873

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1874

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1875

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1876

},

1877

"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]

1878

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1879

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1880

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1881

# The value must be between 1 and 255 characters.

1882

"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.

1883

# The value must be between 1 and 1024 characters.

1884

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1885

"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-zero number.

1886

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1887

{ # 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

1888

"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.

1889

"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.

1890

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1891

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1892

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1893

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1894

{ # Specification determining how headers are added to requests or responses.

1895

"headerName": "A String", # The name of the header.

1896

"headerValue": "A String", # The value of the header to add.

1897

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1898

# The default value is false.

1899

},

1900

],

1901

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1902

"A String",

1903

],

1904

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1905

{ # Specification determining how headers are added to requests or responses.

1906

"headerName": "A String", # The name of the header.

1907

"headerValue": "A String", # The value of the header to add.

1908

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1909

# The default value is false.

1910

},

1911

],

1912

"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) .

1917

# 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.

1918

# 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.

1923

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1924

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1925

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1926

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1927

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1928

# The value must be between 1 and 255 characters.

1929

"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.

1930

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1931

# The default is set to false.

1932

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1933

# 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.

1934

# The value must be between 1 and 1024 characters.

1935

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1936

# 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.

1937

# The value must be between 1 and 1024 characters.

1938

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1939

# Supported values are:

1940

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1941

# - FOUND, which corresponds to 302.

1942

# - SEE_OTHER which corresponds to 303.

1943

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1944

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1945

"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.

1946

# 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.

1953

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1954

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1955

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1956

{ # Message for the expected URL mappings.

1957

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1958

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1959

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1960

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

1961

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1962

},

1963

],

1964

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1968

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1969

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

1970

1971

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1972

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1973

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1974

The object takes the form of:

1975

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1976

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1977

#

1978

# Google Compute Engine has two URL Map resources:

1979

#

1980

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

1981

#

1982

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

1983

#

1984

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

1985

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1986

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

1987

#

1988

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

1989

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1990

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

1991

#

1992

# 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.

1993

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

1994

"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.

1995

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1996

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1997

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1998

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1999

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2000

"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.

2001

# Default is false.

2002

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2003

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2004

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2005

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2006

"A String",

2007

],

2008

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2009

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2010

"A String",

2011

],

2012

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2013

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2014

"A String",

2015

],

2016

"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.

2017

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2018

"A String",

2019

],

2020

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2021

},

2022

"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.

2023

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2024

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2025

"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.

2026

"httpStatus": 42, # The HTTP status code used to abort the request.

2027

# The value must be between 200 and 599 inclusive.

2028

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2029

# The value must be between 0.0 and 100.0 inclusive.

2030

},

2031

"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.

2032

"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.

2033

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2034

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2035

},

2036

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2037

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2038

},

2039

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2040

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2041

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2042

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2043

},

2044

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2045

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2046

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2047

"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.

2048

# 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.

2049

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2050

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2051

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2052

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2053

# - 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.

2054

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2055

# -

2056

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2057

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2058

# - 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.

2059

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2060

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2061

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2062

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2063

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2064

],

2065

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2066

"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.

2067

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2068

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2069

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2070

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2071

},

2072

"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]

2073

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2074

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2075

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2076

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2077

"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.

2078

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2079

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2080

"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-zero number.

2081

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2082

{ # 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

2083

"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.

2084

"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.

2085

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2086

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2087

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2088

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2089

{ # Specification determining how headers are added to requests or responses.

2090

"headerName": "A String", # The name of the header.

2091

"headerValue": "A String", # The value of the header to add.

2092

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2093

# The default value is false.

2094

},

2095

],

2096

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2097

"A String",

2098

],

2099

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2100

{ # Specification determining how headers are added to requests or responses.

2101

"headerName": "A String", # The name of the header.

2102

"headerValue": "A String", # The value of the header to add.

2103

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2104

# The default value is false.

2105

},

2106

],

2107

"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) .

2112

# 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.

2113

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2114

},

2115

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2116

},

2117

"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.

2118

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2119

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2120

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2121

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2122

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2123

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2124

# The value must be between 1 and 255 characters.

2125

"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.

2126

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2127

# The default is set to false.

2128

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2129

# 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.

2130

# The value must be between 1 and 1024 characters.

2131

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2132

# 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.

2133

# The value must be between 1 and 1024 characters.

2134

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2135

# Supported values are:

2136

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2137

# - FOUND, which corresponds to 302.

2138

# - SEE_OTHER which corresponds to 303.

2139

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2140

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2141

"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.

2142

# The default is set to false.

2143

},

2144

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2145

"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.

2146

#

2147

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2148

"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.

2149

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2150

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2151

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2152

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2153

{ # Specification determining how headers are added to requests or responses.

2154

"headerName": "A String", # The name of the header.

2155

"headerValue": "A String", # The value of the header to add.

2156

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2157

# The default value is false.

2158

},

2159

],

2160

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2161

"A String",

2162

],

2163

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2164

{ # Specification determining how headers are added to requests or responses.

2165

"headerName": "A String", # The name of the header.

2166

"headerValue": "A String", # The value of the header to add.

2167

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2168

# The default value is false.

2169

},

2170

],

2171

"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.

2176

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2177

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2178

"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 ..

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2179

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2180

"A String",

2181

],

2182

"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.

2183

},

2184

],

2185

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2186

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2187

"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.

2188

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2189

{ # 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.

2190

"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.

2191

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2192

# 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]

2193

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2194

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2195

"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.

2196

# Default is false.

2197

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2198

"A String",

2199

],

2200

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2201

"A String",

2202

],

2203

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2204

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2205

"A String",

2206

],

2207

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2208

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2209

"A String",

2210

],

2211

"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.

2212

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2213

"A String",

2214

],

2215

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2216

},

2217

"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.

2218

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2219

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2220

"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.

2221

"httpStatus": 42, # The HTTP status code used to abort the request.

2222

# The value must be between 200 and 599 inclusive.

2223

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2224

# The value must be between 0.0 and 100.0 inclusive.

2225

},

2226

"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.

2227

"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.

2228

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2229

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2230

},

2231

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2232

# The value must be between 0.0 and 100.0 inclusive.

2233

},

2234

},

2235

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2236

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2237

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2238

},

2239

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2240

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2241

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2242

"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.

2243

# 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.

2244

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2245

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2246

},

2247

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2248

# - 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.

2249

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2250

# -

2251

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2252

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2253

# - 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.

2254

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2255

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2256

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2257

# - 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.

2262

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2263

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2264

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2265

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2266

},

2267

"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]

2268

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2269

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2270

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2271

# The value must be between 1 and 255 characters.

2272

"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.

2273

# The value must be between 1 and 1024 characters.

2274

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2275

"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-zero number.

2276

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2277

{ # 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

2278

"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.

2279

"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.

2280

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2281

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2282

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2283

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2284

{ # Specification determining how headers are added to requests or responses.

2285

"headerName": "A String", # The name of the header.

2286

"headerValue": "A String", # The value of the header to add.

2287

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2288

# The default value is false.

2289

},

2290

],

2291

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2292

"A String",

2293

],

2294

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2295

{ # Specification determining how headers are added to requests or responses.

2296

"headerName": "A String", # The name of the header.

2297

"headerValue": "A String", # The value of the header to add.

2298

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2299

# The default value is false.

2300

},

2301

],

2302

"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) .

2307

# 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.

2308

# 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:

2313

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2314

# - compute/v1/projects/project/global/backendServices/backendService

2315

# - 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.

2316

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2317

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2318

# - compute.backendBuckets.use

2319

# - compute.backendServices.use

2320

"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.

2321

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2322

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2323

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2324

# The value must be between 1 and 255 characters.

2325

"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.

2326

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2327

# The default is set to false.

2328

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2329

# 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.

2330

# The value must be between 1 and 1024 characters.

2331

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2332

# 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.

2333

# The value must be between 1 and 1024 characters.

2334

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2335

# Supported values are:

2336

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2337

# - FOUND, which corresponds to 302.

2338

# - SEE_OTHER which corresponds to 303.

2339

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2340

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2341

"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.

2342

# The default is set to false.

2343

},

2344

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2345

"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.

2346

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2347

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2348

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2349

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2350

{ # Specification determining how headers are added to requests or responses.

2351

"headerName": "A String", # The name of the header.

2352

"headerValue": "A String", # The value of the header to add.

2353

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2354

# The default value is false.

2355

},

2356

],

2357

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2358

"A String",

2359

],

2360

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2361

{ # Specification determining how headers are added to requests or responses.

2362

"headerName": "A String", # The name of the header.

2363

"headerValue": "A String", # The value of the header to add.

2364

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2365

# The default value is false.

2366

},

2367

],

2368

"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.

2373

"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.

2374

# 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.

2375

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2376

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2377

"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.

2378

"A String",

2379

],

2380

"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.

2381

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2382

# 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]

2383

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2384

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2385

"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.

2386

# Default is false.

2387

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2388

"A String",

2389

],

2390

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2391

"A String",

2392

],

2393

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2394

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2395

"A String",

2396

],

2397

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2398

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2399

"A String",

2400

],

2401

"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.

2402

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2403

"A String",

2404

],

2405

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2406

},

2407

"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.

2408

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2409

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2410

"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.

2411

"httpStatus": 42, # The HTTP status code used to abort the request.

2412

# The value must be between 200 and 599 inclusive.

2413

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2414

# The value must be between 0.0 and 100.0 inclusive.

2415

},

2416

"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.

2417

"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.

2418

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2419

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2420

},

2421

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2422

# The value must be between 0.0 and 100.0 inclusive.

2423

},

2424

},

2425

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2426

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2427

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2428

},

2429

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2430

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2431

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2432

"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.

2433

# 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.

2434

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2435

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2436

},

2437

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2438

# - 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.

2439

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2440

# -

2441

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2442

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2443

# - 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.

2444

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2445

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2446

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2447

# - 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.

2452

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2453

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2454

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2455

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2456

},

2457

"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]

2458

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2459

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2460

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2461

# The value must be between 1 and 255 characters.

2462

"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.

2463

# The value must be between 1 and 1024 characters.

2464

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2465

"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-zero number.

2466

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2467

{ # 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

2468

"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.

2469

"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.

2470

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2471

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2472

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2473

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2474

{ # Specification determining how headers are added to requests or responses.

2475

"headerName": "A String", # The name of the header.

2476

"headerValue": "A String", # The value of the header to add.

2477

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2478

# The default value is false.

2479

},

2480

],

2481

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2482

"A String",

2483

],

2484

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2485

{ # Specification determining how headers are added to requests or responses.

2486

"headerName": "A String", # The name of the header.

2487

"headerValue": "A String", # The value of the header to add.

2488

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2489

# The default value is false.

2490

},

2491

],

2492

"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) .

2497

# 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.

2498

# 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.

2503

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2504

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2505

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2506

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2507

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2508

# The value must be between 1 and 255 characters.

2509

"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.

2510

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2511

# The default is set to false.

2512

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2513

# 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.

2514

# The value must be between 1 and 1024 characters.

2515

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2516

# 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.

2517

# The value must be between 1 and 1024 characters.

2518

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2519

# Supported values are:

2520

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2521

# - FOUND, which corresponds to 302.

2522

# - SEE_OTHER which corresponds to 303.

2523

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2524

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2525

"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.

2526

# 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.

2531

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2532

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2533

"description": "A String", # The short description conveying the intent of this routeRule.

2534

# The description can have a maximum length of 1024 characters.

2535

"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.

2536

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2537

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2538

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2539

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2540

{ # Specification determining how headers are added to requests or responses.

2541

"headerName": "A String", # The name of the header.

2542

"headerValue": "A String", # The value of the header to add.

2543

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2544

# The default value is false.

2545

},

2546

],

2547

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2548

"A String",

2549

],

2550

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2551

{ # Specification determining how headers are added to requests or responses.

2552

"headerName": "A String", # The name of the header.

2553

"headerValue": "A String", # The value of the header to add.

2554

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2555

# The default value is false.

2556

},

2557

],

2558

"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.

2559

"A String",

2560

],

2561

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2562

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2563

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

2564

"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.

2565

# fullPathMatch must be between 1 and 1024 characters.

2566

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2567

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2568

{ # matchRule criteria for request header matches.

2569

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2570

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2571

"headerName": "A String", # The name of the HTTP header to match.

2572

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2573

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2574

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2575

"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.

2576

# The default setting is false.

2577

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2578

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2579

"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.

2580

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2581

"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.

2582

# For example for a range [-5, 0]

2583

# - -3 will match.

2584

# - 0 will not match.

2585

# - 0.25 will not match.

2586

# - -3someString will not match.

2587

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2588

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2589

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2590

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2591

},

2592

"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

2593

# 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.

2594

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2595

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2596

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2597

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2598

},

2599

],

2600

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2601

# The default value is false.

2602

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2603

# Not supported when the URL map is bound to target gRPC proxy.

2604

"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. When there is a match, the relevant routing configuration is made available to those proxies.

2605

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2606

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2607

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2608

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2609

{ # 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.

2610

# 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.

2611

# 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.

2612

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2613

# This list must not be empty and can have at the most 64 entries.

2614

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2615

"name": "A String", # Name of metadata label.

2616

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2617

"value": "A String", # The value of the label must match the specified value.

2618

# value can have a maximum length of 1024 characters.

2619

},

2620

],

2621

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2622

# Supported values are:

2623

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2624

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2625

},

2626

],

2627

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2628

# The value must be between 1 and 1024 characters.

2629

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2630

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2631

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2632

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2633

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2634

# Only one of presentMatch, exactMatch or regexMatch must be set.

2635

"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.

2636

"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.

2637

# Only one of presentMatch, exactMatch or regexMatch must be set.

2638

"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

2639

# Only one of presentMatch, exactMatch or regexMatch must be set.

2640

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2641

},

2642

],

2643

"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

2644

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2645

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2646

},

2647

],

2648

"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.

2649

# 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.

2650

# 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.

2651

"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.

2652

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2653

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2654

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2655

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2656

"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.

2657

# Default is false.

2658

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2659

"A String",

2660

],

2661

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2662

"A String",

2663

],

2664

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2665

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2666

"A String",

2667

],

2668

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2669

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2670

"A String",

2671

],

2672

"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.

2673

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2674

"A String",

2675

],

2676

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2677

},

2678

"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.

2679

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2680

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2681

"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.

2682

"httpStatus": 42, # The HTTP status code used to abort the request.

2683

# The value must be between 200 and 599 inclusive.

2684

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2685

# The value must be between 0.0 and 100.0 inclusive.

2686

},

2687

"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.

2688

"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.

2689

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2690

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2691

},

2692

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2693

# The value must be between 0.0 and 100.0 inclusive.

2694

},

2695

},

2696

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2697

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2698

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2699

},

2700

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2701

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2702

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2703

"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.

2704

# 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.

2705

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2706

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2707

},

2708

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2709

# - 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.

2710

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2711

# -

2712

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2713

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2714

# - 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.

2715

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2716

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2717

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2718

# - 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.

2723

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2724

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2725

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2726

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2727

},

2728

"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]

2729

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2730

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2731

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2732

# The value must be between 1 and 255 characters.

2733

"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.

2734

# The value must be between 1 and 1024 characters.

2735

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2736

"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-zero number.

2737

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2738

{ # 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

2739

"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.

2740

"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.

2741

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2742

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2743

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2744

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2745

{ # Specification determining how headers are added to requests or responses.

2746

"headerName": "A String", # The name of the header.

2747

"headerValue": "A String", # The value of the header to add.

2748

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2749

# The default value is false.

2750

},

2751

],

2752

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2753

"A String",

2754

],

2755

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2756

{ # Specification determining how headers are added to requests or responses.

2757

"headerName": "A String", # The name of the header.

2758

"headerValue": "A String", # The value of the header to add.

2759

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2760

# The default value is false.

2761

},

2762

],

2763

"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) .

2768

# 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.

2769

# 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.

2774

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2775

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2776

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2777

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2778

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2779

# The value must be between 1 and 255 characters.

2780

"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.

2781

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2782

# The default is set to false.

2783

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2784

# 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.

2785

# The value must be between 1 and 1024 characters.

2786

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2787

# 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.

2788

# The value must be between 1 and 1024 characters.

2789

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2790

# Supported values are:

2791

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2792

# - FOUND, which corresponds to 302.

2793

# - SEE_OTHER which corresponds to 303.

2794

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2795

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2796

"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.

2797

# 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.

2804

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2805

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2806

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2807

{ # Message for the expected URL mappings.

2808

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2809

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2810

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2811

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

2812

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2813

},

2814

],

2815

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2816

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2817

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.

2818

2819

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.

2820

2821

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2822

2823

Returns:

2824

An object of the form:

2825

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2826

{ # Represents an Operation resource.

2827

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2828

# Google Compute Engine has three Operation resources:

2829

#

2830

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2831

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2832

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2833

#

2834

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2835

# - For global operations, use the `globalOperations` resource.

2836

# - For regional operations, use the `regionOperations` resource.

2837

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2838

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2839

# 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]

2840

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2841

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2842

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2843

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2844

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2845

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2846

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2847

"code": "A String", # [Output Only] The error type identifier for this error.

2848

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2849

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2850

},

2851

],

2852

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2853

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2854

"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.

2855

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2856

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2857

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2858

"name": "A String", # [Output Only] Name of the operation.

2859

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2860

"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.

2861

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2862

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2863

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2864

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2865

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2866

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2867

"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.

2868

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2869

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2870

{

2871

"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.

2872

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2873

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2874

{

2875

"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).

2876

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2877

},

2878

],

2879

"message": "A String", # [Output Only] A human-readable description of the warning code.

2880

},

2881

],

2882

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2887

<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body=None, requestId=None)</code>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2888

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

2889

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

2890

For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).

2891

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2892

Args:

2893

project: string, Project ID for this request. (required)

2894

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2895

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2896

The object takes the form of:

2897

2898

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2899

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

2900

"path": "A String",

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2901

}

2902

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2903

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.

2904

2905

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.

2906

2907

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2908

2909

Returns:

2910

An object of the form:

2911

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2912

{ # Represents an Operation resource.

2913

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2914

# Google Compute Engine has three Operation resources:

2915

#

2916

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2917

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2918

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2919

#

2920

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2921

# - For global operations, use the `globalOperations` resource.

2922

# - For regional operations, use the `regionOperations` resource.

2923

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2924

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2925

# 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]

2926

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2927

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2928

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2929

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2930

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2931

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2932

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2933

"code": "A String", # [Output Only] The error type identifier for this error.

2934

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2935

"message": "A String", # [Output Only] An optional, human-readable error message.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2936

},

2937

],

2938

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2939

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2940

"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.

2941

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2942

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2943

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2944

"name": "A String", # [Output Only] Name of the operation.

2945

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2946

"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.

2947

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2948

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2949

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2950

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2951

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2952

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2953

"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.

2954

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2955

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2956

{

2957

"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.

2958

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2959

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2960

{

2961

"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).

2962

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2963

},

2964

],

2965

"message": "A String", # [Output Only] A human-readable description of the warning code.

2966

},

2967

],

2968

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2973

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2974

<pre>Retrieves the list of UrlMap resources available to the specified project.

2975

2976

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2977

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2978

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2979

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2980

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2981

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2982

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2983

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2984

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) ```

2985

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`)

2986

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

2987

2988

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.

2989

2990

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

2991

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2992

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.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2993

2994

Returns:

2995

An object of the form:

2996

2997

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2998

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2999

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3000

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3001

#

3002

# Google Compute Engine has two URL Map resources:

3003

#

3004

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3005

#

3006

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3007

#

3008

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3009

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3010

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

3011

#

3012

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

3013

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3014

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3015

#

3016

# 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.

3017

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3018

"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.

3019

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3020

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3021

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3022

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3023

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3024

"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.

3025

# Default is false.

3026

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3027

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3028

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3030

"A String",

3031

],

3032

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3033

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3034

"A String",

3035

],

3036

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3037

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3038

"A String",

3039

],

3040

"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.

3041

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3042

"A String",

3043

],

3044

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3045

},

3046

"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.

3047

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3048

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3049

"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.

3050

"httpStatus": 42, # The HTTP status code used to abort the request.

3051

# The value must be between 200 and 599 inclusive.

3052

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3053

# The value must be between 0.0 and 100.0 inclusive.

3054

},

3055

"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.

3056

"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.

3057

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3058

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3059

},

3060

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3061

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3062

},

3063

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3064

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3065

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3066

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3067

},

3068

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3069

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3070

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3071

"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.

3072

# 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.

3073

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3074

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3075

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3076

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3077

# - 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.

3078

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3079

# -

3080

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3081

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3082

# - 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.

3083

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3084

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3085

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3086

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3087

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3088

],

3089

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3090

"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.

3091

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3092

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3093

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3094

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3095

},

3096

"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]

3097

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3098

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3099

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3100

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3101

"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.

3102

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3103

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3104

"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-zero number.

3105

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3106

{ # 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

3107

"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.

3108

"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.

3109

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3110

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3111

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3112

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3113

{ # Specification determining how headers are added to requests or responses.

3114

"headerName": "A String", # The name of the header.

3115

"headerValue": "A String", # The value of the header to add.

3116

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3117

# The default value is false.

3118

},

3119

],

3120

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3121

"A String",

3122

],

3123

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3124

{ # Specification determining how headers are added to requests or responses.

3125

"headerName": "A String", # The name of the header.

3126

"headerValue": "A String", # The value of the header to add.

3127

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3128

# The default value is false.

3129

},

3130

],

3131

"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) .

3136

# 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.

3137

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3138

},

3139

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3140

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3141

"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.

3142

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3143

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3144

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3145

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3146

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3147

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3148

# The value must be between 1 and 255 characters.

3149

"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.

3150

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3151

# The default is set to false.

3152

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3153

# 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.

3154

# The value must be between 1 and 1024 characters.

3155

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3156

# 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.

3157

# The value must be between 1 and 1024 characters.

3158

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3159

# Supported values are:

3160

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3161

# - FOUND, which corresponds to 302.

3162

# - SEE_OTHER which corresponds to 303.

3163

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3164

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3165

"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.

3166

# The default is set to false.

3167

},

3168

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3169

"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.

3170

#

3171

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3172

"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.

3173

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3174

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3175

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3176

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3177

{ # Specification determining how headers are added to requests or responses.

3178

"headerName": "A String", # The name of the header.

3179

"headerValue": "A String", # The value of the header to add.

3180

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3181

# The default value is false.

3182

},

3183

],

3184

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3185

"A String",

3186

],

3187

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3188

{ # Specification determining how headers are added to requests or responses.

3189

"headerName": "A String", # The name of the header.

3190

"headerValue": "A String", # The value of the header to add.

3191

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3192

# The default value is false.

3193

},

3194

],

3195

"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.

3200

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3201

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3202

"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 ..

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3203

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3204

"A String",

3205

],

3206

"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.

3207

},

3208

],

3209

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3210

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3211

"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.

3212

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3213

{ # 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.

3214

"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.

3215

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3216

# 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]

3217

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3218

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3219

"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.

3220

# Default is false.

3221

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3222

"A String",

3223

],

3224

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3225

"A String",

3226

],

3227

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3228

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3229

"A String",

3230

],

3231

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3232

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3233

"A String",

3234

],

3235

"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.

3236

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3237

"A String",

3238

],

3239

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3240

},

3241

"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.

3242

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3243

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3244

"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.

3245

"httpStatus": 42, # The HTTP status code used to abort the request.

3246

# The value must be between 200 and 599 inclusive.

3247

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3248

# The value must be between 0.0 and 100.0 inclusive.

3249

},

3250

"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.

3251

"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.

3252

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3253

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3254

},

3255

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3256

# The value must be between 0.0 and 100.0 inclusive.

3257

},

3258

},

3259

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3260

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3261

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3262

},

3263

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3264

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3265

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3266

"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.

3267

# 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.

3268

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3269

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3270

},

3271

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3272

# - 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.

3273

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3274

# -

3275

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3276

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3277

# - 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.

3278

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3279

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3280

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3281

# - 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.

3286

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3287

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3288

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3289

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3290

},

3291

"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]

3292

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3293

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3294

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3295

# The value must be between 1 and 255 characters.

3296

"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.

3297

# The value must be between 1 and 1024 characters.

3298

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3299

"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-zero number.

3300

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3301

{ # 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

3302

"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.

3303

"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.

3304

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3305

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3306

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3307

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3308

{ # Specification determining how headers are added to requests or responses.

3309

"headerName": "A String", # The name of the header.

3310

"headerValue": "A String", # The value of the header to add.

3311

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3312

# The default value is false.

3313

},

3314

],

3315

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3316

"A String",

3317

],

3318

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3319

{ # Specification determining how headers are added to requests or responses.

3320

"headerName": "A String", # The name of the header.

3321

"headerValue": "A String", # The value of the header to add.

3322

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3323

# The default value is false.

3324

},

3325

],

3326

"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) .

3331

# 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.

3332

# 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:

3337

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3338

# - compute/v1/projects/project/global/backendServices/backendService

3339

# - 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.

3340

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3341

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3342

# - compute.backendBuckets.use

3343

# - compute.backendServices.use

3344

"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.

3345

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3346

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3347

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3348

# The value must be between 1 and 255 characters.

3349

"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.

3350

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3351

# The default is set to false.

3352

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3353

# 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.

3354

# The value must be between 1 and 1024 characters.

3355

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3356

# 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.

3357

# The value must be between 1 and 1024 characters.

3358

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3359

# Supported values are:

3360

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3361

# - FOUND, which corresponds to 302.

3362

# - SEE_OTHER which corresponds to 303.

3363

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3364

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3365

"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.

3366

# The default is set to false.

3367

},

3368

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3369

"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.

3370

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3371

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3372

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3373

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3374

{ # Specification determining how headers are added to requests or responses.

3375

"headerName": "A String", # The name of the header.

3376

"headerValue": "A String", # The value of the header to add.

3377

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3378

# The default value is false.

3379

},

3380

],

3381

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3382

"A String",

3383

],

3384

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3385

{ # Specification determining how headers are added to requests or responses.

3386

"headerName": "A String", # The name of the header.

3387

"headerValue": "A String", # The value of the header to add.

3388

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3389

# The default value is false.

3390

},

3391

],

3392

"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.

3397

"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.

3398

# 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.

3399

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3400

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3401

"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.

3402

"A String",

3403

],

3404

"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.

3405

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3406

# 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]

3407

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3408

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3409

"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.

3410

# Default is false.

3411

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3412

"A String",

3413

],

3414

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3415

"A String",

3416

],

3417

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3418

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3419

"A String",

3420

],

3421

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3422

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3423

"A String",

3424

],

3425

"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.

3426

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3427

"A String",

3428

],

3429

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3430

},

3431

"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.

3432

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3433

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3434

"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.

3435

"httpStatus": 42, # The HTTP status code used to abort the request.

3436

# The value must be between 200 and 599 inclusive.

3437

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3438

# The value must be between 0.0 and 100.0 inclusive.

3439

},

3440

"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.

3441

"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.

3442

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3443

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3444

},

3445

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3446

# The value must be between 0.0 and 100.0 inclusive.

3447

},

3448

},

3449

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3450

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3451

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3452

},

3453

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3454

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3455

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3456

"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.

3457

# 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.

3458

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3459

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3460

},

3461

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3462

# - 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.

3463

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3464

# -

3465

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3466

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3467

# - 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.

3468

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3469

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3470

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3471

# - 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.

3476

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3477

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3478

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3479

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3480

},

3481

"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]

3482

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3483

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3484

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3485

# The value must be between 1 and 255 characters.

3486

"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.

3487

# The value must be between 1 and 1024 characters.

3488

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3489

"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-zero number.

3490

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3491

{ # 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

3492

"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.

3493

"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.

3494

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3495

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3496

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3497

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3498

{ # Specification determining how headers are added to requests or responses.

3499

"headerName": "A String", # The name of the header.

3500

"headerValue": "A String", # The value of the header to add.

3501

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3502

# The default value is false.

3503

},

3504

],

3505

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3506

"A String",

3507

],

3508

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3509

{ # Specification determining how headers are added to requests or responses.

3510

"headerName": "A String", # The name of the header.

3511

"headerValue": "A String", # The value of the header to add.

3512

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3513

# The default value is false.

3514

},

3515

],

3516

"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) .

3521

# 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.

3522

# 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.

3527

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3528

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3529

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3530

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3531

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3532

# The value must be between 1 and 255 characters.

3533

"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.

3534

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3535

# The default is set to false.

3536

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3537

# 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.

3538

# The value must be between 1 and 1024 characters.

3539

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3540

# 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.

3541

# The value must be between 1 and 1024 characters.

3542

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3543

# Supported values are:

3544

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3545

# - FOUND, which corresponds to 302.

3546

# - SEE_OTHER which corresponds to 303.

3547

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3548

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3549

"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.

3550

# 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.

3555

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3556

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3557

"description": "A String", # The short description conveying the intent of this routeRule.

3558

# The description can have a maximum length of 1024 characters.

3559

"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.

3560

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3561

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3562

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3563

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3564

{ # Specification determining how headers are added to requests or responses.

3565

"headerName": "A String", # The name of the header.

3566

"headerValue": "A String", # The value of the header to add.

3567

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3568

# The default value is false.

3569

},

3570

],

3571

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3572

"A String",

3573

],

3574

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3575

{ # Specification determining how headers are added to requests or responses.

3576

"headerName": "A String", # The name of the header.

3577

"headerValue": "A String", # The value of the header to add.

3578

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3579

# The default value is false.

3580

},

3581

],

3582

"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.

3583

"A String",

3584

],

3585

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3586

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3587

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

3588

"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.

3589

# fullPathMatch must be between 1 and 1024 characters.

3590

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3591

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3592

{ # matchRule criteria for request header matches.

3593

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3594

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3595

"headerName": "A String", # The name of the HTTP header to match.

3596

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3597

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3598

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3599

"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.

3600

# The default setting is false.

3601

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3602

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3603

"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.

3604

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3605

"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.

3606

# For example for a range [-5, 0]

3607

# - -3 will match.

3608

# - 0 will not match.

3609

# - 0.25 will not match.

3610

# - -3someString will not match.

3611

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3612

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3613

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3614

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3615

},

3616

"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

3617

# 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.

3618

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3619

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3620

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3621

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3622

},

3623

],

3624

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3625

# The default value is false.

3626

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3627

# Not supported when the URL map is bound to target gRPC proxy.

3628

"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. When there is a match, the relevant routing configuration is made available to those proxies.

3629

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3630

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3631

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3632

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3633

{ # 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.

3634

# 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.

3635

# 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.

3636

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3637

# This list must not be empty and can have at the most 64 entries.

3638

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3639

"name": "A String", # Name of metadata label.

3640

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3641

"value": "A String", # The value of the label must match the specified value.

3642

# value can have a maximum length of 1024 characters.

3643

},

3644

],

3645

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3646

# Supported values are:

3647

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3648

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3649

},

3650

],

3651

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3652

# The value must be between 1 and 1024 characters.

3653

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3654

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3655

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3656

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3657

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3658

# Only one of presentMatch, exactMatch or regexMatch must be set.

3659

"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.

3660

"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.

3661

# Only one of presentMatch, exactMatch or regexMatch must be set.

3662

"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

3663

# Only one of presentMatch, exactMatch or regexMatch must be set.

3664

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3665

},

3666

],

3667

"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

3668

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3669

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3670

},

3671

],

3672

"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.

3673

# 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.

3674

# 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.

3675

"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.

3676

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3677

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3678

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3679

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3680

"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.

3681

# Default is false.

3682

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3683

"A String",

3684

],

3685

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3686

"A String",

3687

],

3688

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3689

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3690

"A String",

3691

],

3692

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3693

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3694

"A String",

3695

],

3696

"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.

3697

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3698

"A String",

3699

],

3700

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3701

},

3702

"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.

3703

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3704

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3705

"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.

3706

"httpStatus": 42, # The HTTP status code used to abort the request.

3707

# The value must be between 200 and 599 inclusive.

3708

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3709

# The value must be between 0.0 and 100.0 inclusive.

3710

},

3711

"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.

3712

"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.

3713

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3714

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3715

},

3716

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3717

# The value must be between 0.0 and 100.0 inclusive.

3718

},

3719

},

3720

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3721

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3722

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3723

},

3724

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3725

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3726

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3727

"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.

3728

# 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.

3729

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3730

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3731

},

3732

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3733

# - 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.

3734

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3735

# -

3736

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3737

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3738

# - 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.

3739

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3740

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3741

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3742

# - 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.

3747

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3748

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3749

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3750

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3751

},

3752

"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]

3753

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3754

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3755

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3756

# The value must be between 1 and 255 characters.

3757

"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.

3758

# The value must be between 1 and 1024 characters.

3759

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3760

"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-zero number.

3761

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3762

{ # 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

3763

"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.

3764

"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.

3765

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3766

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3767

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3768

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3769

{ # Specification determining how headers are added to requests or responses.

3770

"headerName": "A String", # The name of the header.

3771

"headerValue": "A String", # The value of the header to add.

3772

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3773

# The default value is false.

3774

},

3775

],

3776

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3777

"A String",

3778

],

3779

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3780

{ # Specification determining how headers are added to requests or responses.

3781

"headerName": "A String", # The name of the header.

3782

"headerValue": "A String", # The value of the header to add.

3783

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3784

# The default value is false.

3785

},

3786

],

3787

"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) .

3792

# 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.

3793

# 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.

3798

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3799

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3800

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3801

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3802

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3803

# The value must be between 1 and 255 characters.

3804

"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.

3805

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3806

# The default is set to false.

3807

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3808

# 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.

3809

# The value must be between 1 and 1024 characters.

3810

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3811

# 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.

3812

# The value must be between 1 and 1024 characters.

3813

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3814

# Supported values are:

3815

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3816

# - FOUND, which corresponds to 302.

3817

# - SEE_OTHER which corresponds to 303.

3818

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3819

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3820

"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.

3821

# 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.

3828

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3829

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3830

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3831

{ # Message for the expected URL mappings.

3832

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3833

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3834

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3835

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

3836

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3837

},

3838

],

3839

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3840

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3841

"kind": "compute#urlMapList", # Type of resource.

3842

"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.

3843

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3844

"warning": { # [Output Only] Informational warning message.

3845

"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.

3846

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3847

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3848

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3849

"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).

3850

"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]

3851

},

3852

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3853

"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]

3854

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3860

<pre>Retrieves the next page of results.

3861

3862

Args:

3863

previous_request: The request for the previous page. (required)

3864

previous_response: The response from the request for the previous page. (required)

3865

3866

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3867

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3868

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]

3873

<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]

3874

<pre>Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3875

3876

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3877

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

3878

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3879

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3880

The object takes the form of:

3881

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3882

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3883

#

3884

# Google Compute Engine has two URL Map resources:

3885

#

3886

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3887

#

3888

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3889

#

3890

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3891

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3892

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

3893

#

3894

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

3895

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3896

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3897

#

3898

# 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.

3899

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3900

"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.

3901

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3902

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3903

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3904

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3905

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3906

"allowCredentials": True or False, # In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.

3907

# Default is false.

3908

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3909

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3910

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3911

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3912

"A String",

3913

],

3914

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3915

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3916

"A String",

3917

],

3918

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3919

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3920

"A String",

3921

],

3922

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

3923

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3924

"A String",

3925

],

3926

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3927

},

3928

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.

3929

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3930

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3931

"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.

3932

"httpStatus": 42, # The HTTP status code used to abort the request.

3933

# The value must be between 200 and 599 inclusive.

3934

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3935

# The value must be between 0.0 and 100.0 inclusive.

3936

},

3937

"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.

3938

"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.

3939

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3940

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3941

},

3942

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3943

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3944

},

3945

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3946

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3947

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3948

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3949

},

3950

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3951

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3952

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3953

"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.

3954

# 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.

3955

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3956

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3957

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3958

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3959

# - 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.

3960

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3961

# -

3962

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3963

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3964

# - 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.

3965

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3966

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3967

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3968

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3969

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3970

],

3971

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3972

"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.

3973

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3974

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3975

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3976

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3977

},

3978

"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]

3979

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3980

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3981

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3982

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3983

"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.

3984

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3985

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3986

"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-zero number.

3987

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3988

{ # 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

3989

"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.

3990

"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.

3991

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3992

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3993

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3994

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3995

{ # Specification determining how headers are added to requests or responses.

3996

"headerName": "A String", # The name of the header.

3997

"headerValue": "A String", # The value of the header to add.

3998

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3999

# The default value is false.

4000

},

4001

],

4002

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4003

"A String",

4004

],

4005

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4006

{ # Specification determining how headers are added to requests or responses.

4007

"headerName": "A String", # The name of the header.

4008

"headerValue": "A String", # The value of the header to add.

4009

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4010

# The default value is false.

4011

},

4012

],

4013

"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) .

4018

# 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.

4019

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4020

},

4021

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4022

},

4023

"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.

4024

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4025

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4026

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4027

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4028

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4029

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4030

# The value must be between 1 and 255 characters.

4031

"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.

4032

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4033

# The default is set to false.

4034

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4035

# 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.

4036

# The value must be between 1 and 1024 characters.

4037

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4038

# 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.

4039

# The value must be between 1 and 1024 characters.

4040

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4041

# Supported values are:

4042

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4043

# - FOUND, which corresponds to 302.

4044

# - SEE_OTHER which corresponds to 303.

4045

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4046

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4047

"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.

4048

# The default is set to false.

4049

},

4050

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4051

"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.

4052

#

4053

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4054

"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.

4055

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4056

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4057

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4058

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4059

{ # Specification determining how headers are added to requests or responses.

4060

"headerName": "A String", # The name of the header.

4061

"headerValue": "A String", # The value of the header to add.

4062

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4063

# The default value is false.

4064

},

4065

],

4066

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4067

"A String",

4068

],

4069

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4070

{ # Specification determining how headers are added to requests or responses.

4071

"headerName": "A String", # The name of the header.

4072

"headerValue": "A String", # The value of the header to add.

4073

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4074

# The default value is false.

4075

},

4076

],

4077

"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.

4082

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4083

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4084

"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 ..

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4085

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4086

"A String",

4087

],

4088

"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.

4089

},

4090

],

4091

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4092

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4093

"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.

4094

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4095

{ # 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.

4096

"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.

4097

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4098

# 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]

4099

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4100

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4125

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4126

"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.

4127

"httpStatus": 42, # The HTTP status code used to abort the request.

4128

# The value must be between 200 and 599 inclusive.

4129

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4130

# The value must be between 0.0 and 100.0 inclusive.

4131

},

4132

"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.

4133

"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.

4134

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4135

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4136

},

4137

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4138

# The value must be between 0.0 and 100.0 inclusive.

4139

},

4140

},

4141

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4142

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4143

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4144

},

4145

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4146

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4147

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4148

"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.

4149

# 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.

4150

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4151

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4152

},

4153

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4154

# - 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.

4155

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4156

# -

4157

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4158

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4159

# - 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.

4160

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4161

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4162

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4163

# - 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.

4168

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4169

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4170

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4171

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4172

},

4173

"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]

4174

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4175

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4176

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4177

# The value must be between 1 and 255 characters.

4178

"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.

4179

# The value must be between 1 and 1024 characters.

4180

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4181

"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-zero number.

4182

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4183

{ # 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

4184

"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.

4185

"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.

4186

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4187

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4188

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4189

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4190

{ # Specification determining how headers are added to requests or responses.

4191

"headerName": "A String", # The name of the header.

4192

"headerValue": "A String", # The value of the header to add.

4193

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4194

# The default value is false.

4195

},

4196

],

4197

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4198

"A String",

4199

],

4200

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4201

{ # Specification determining how headers are added to requests or responses.

4202

"headerName": "A String", # The name of the header.

4203

"headerValue": "A String", # The value of the header to add.

4204

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4205

# The default value is false.

4206

},

4207

],

4208

"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) .

4213

# 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.

4214

# 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:

4219

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4220

# - compute/v1/projects/project/global/backendServices/backendService

4221

# - 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.

4222

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4223

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4224

# - compute.backendBuckets.use

4225

# - compute.backendServices.use

4226

"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.

4227

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4228

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4229

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4230

# The value must be between 1 and 255 characters.

4231

"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.

4232

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4233

# The default is set to false.

4234

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4235

# 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.

4236

# The value must be between 1 and 1024 characters.

4237

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4238

# 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.

4239

# The value must be between 1 and 1024 characters.

4240

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4241

# Supported values are:

4242

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4243

# - FOUND, which corresponds to 302.

4244

# - SEE_OTHER which corresponds to 303.

4245

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4246

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4247

"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.

4248

# The default is set to false.

4249

},

4250

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4251

"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.

4252

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4253

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4254

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4255

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4256

{ # Specification determining how headers are added to requests or responses.

4257

"headerName": "A String", # The name of the header.

4258

"headerValue": "A String", # The value of the header to add.

4259

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4260

# The default value is false.

4261

},

4262

],

4263

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4264

"A String",

4265

],

4266

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4267

{ # Specification determining how headers are added to requests or responses.

4268

"headerName": "A String", # The name of the header.

4269

"headerValue": "A String", # The value of the header to add.

4270

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4271

# The default value is false.

4272

},

4273

],

4274

"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.

4279

"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.

4280

# 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.

4281

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4282

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4283

"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.

4284

"A String",

4285

],

4286

"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.

4287

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4288

# 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]

4289

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4290

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4291

"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.

4292

# Default is false.

4293

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4294

"A String",

4295

],

4296

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4297

"A String",

4298

],

4299

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4300

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4301

"A String",

4302

],

4303

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4304

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4305

"A String",

4306

],

4307

"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.

4308

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4309

"A String",

4310

],

4311

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4312

},

4313

"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.

4314

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4315

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4316

"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.

4317

"httpStatus": 42, # The HTTP status code used to abort the request.

4318

# The value must be between 200 and 599 inclusive.

4319

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4320

# The value must be between 0.0 and 100.0 inclusive.

4321

},

4322

"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.

4323

"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.

4324

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4325

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4326

},

4327

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4328

# The value must be between 0.0 and 100.0 inclusive.

4329

},

4330

},

4331

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4332

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4333

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4334

},

4335

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4336

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4337

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4338

"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.

4339

# 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.

4340

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4341

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4342

},

4343

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4344

# - 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.

4345

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4346

# -

4347

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4348

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4349

# - 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.

4350

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4351

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4352

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4353

# - 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.

4358

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4359

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4360

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4361

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4362

},

4363

"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]

4364

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4365

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4366

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4367

# The value must be between 1 and 255 characters.

4368

"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.

4369

# The value must be between 1 and 1024 characters.

4370

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4371

"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-zero number.

4372

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4373

{ # 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

4374

"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.

4375

"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.

4376

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4377

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4378

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4379

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4380

{ # Specification determining how headers are added to requests or responses.

4381

"headerName": "A String", # The name of the header.

4382

"headerValue": "A String", # The value of the header to add.

4383

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4384

# The default value is false.

4385

},

4386

],

4387

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4388

"A String",

4389

],

4390

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4391

{ # Specification determining how headers are added to requests or responses.

4392

"headerName": "A String", # The name of the header.

4393

"headerValue": "A String", # The value of the header to add.

4394

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4395

# The default value is false.

4396

},

4397

],

4398

"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) .

4403

# 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.

4404

# 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.

4409

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4410

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4411

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4412

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4413

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4414

# The value must be between 1 and 255 characters.

4415

"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.

4416

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4417

# The default is set to false.

4418

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4419

# 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.

4420

# The value must be between 1 and 1024 characters.

4421

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4422

# 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.

4423

# The value must be between 1 and 1024 characters.

4424

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4425

# Supported values are:

4426

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4427

# - FOUND, which corresponds to 302.

4428

# - SEE_OTHER which corresponds to 303.

4429

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4430

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4431

"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.

4432

# 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.

4437

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4438

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4439

"description": "A String", # The short description conveying the intent of this routeRule.

4440

# The description can have a maximum length of 1024 characters.

4441

"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.

4442

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4443

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4444

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4445

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4446

{ # Specification determining how headers are added to requests or responses.

4447

"headerName": "A String", # The name of the header.

4448

"headerValue": "A String", # The value of the header to add.

4449

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4450

# The default value is false.

4451

},

4452

],

4453

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4454

"A String",

4455

],

4456

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4457

{ # Specification determining how headers are added to requests or responses.

4458

"headerName": "A String", # The name of the header.

4459

"headerValue": "A String", # The value of the header to add.

4460

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4461

# The default value is false.

4462

},

4463

],

4464

"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.

4465

"A String",

4466

],

4467

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4468

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4469

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

4470

"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.

4471

# fullPathMatch must be between 1 and 1024 characters.

4472

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4473

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4474

{ # matchRule criteria for request header matches.

4475

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4476

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4477

"headerName": "A String", # The name of the HTTP header to match.

4478

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4479

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4480

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4481

"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.

4482

# The default setting is false.

4483

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4484

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4485

"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.

4486

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4487

"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.

4488

# For example for a range [-5, 0]

4489

# - -3 will match.

4490

# - 0 will not match.

4491

# - 0.25 will not match.

4492

# - -3someString will not match.

4493

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4494

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4495

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4496

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4497

},

4498

"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

4499

# 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.

4500

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4501

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4502

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4503

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4504

},

4505

],

4506

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4507

# The default value is false.

4508

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4509

# Not supported when the URL map is bound to target gRPC proxy.

4510

"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. When there is a match, the relevant routing configuration is made available to those proxies.

4511

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4512

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4513

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4514

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4515

{ # 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.

4516

# 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.

4517

# 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.

4518

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4519

# This list must not be empty and can have at the most 64 entries.

4520

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4521

"name": "A String", # Name of metadata label.

4522

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4523

"value": "A String", # The value of the label must match the specified value.

4524

# value can have a maximum length of 1024 characters.

4525

},

4526

],

4527

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4528

# Supported values are:

4529

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4530

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4531

},

4532

],

4533

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4534

# The value must be between 1 and 1024 characters.

4535

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4536

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4537

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4538

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4539

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4540

# Only one of presentMatch, exactMatch or regexMatch must be set.

4541

"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.

4542

"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.

4543

# Only one of presentMatch, exactMatch or regexMatch must be set.

4544

"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

4545

# Only one of presentMatch, exactMatch or regexMatch must be set.

4546

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4547

},

4548

],

4549

"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

4550

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4551

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4552

},

4553

],

4554

"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.

4555

# 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.

4556

# 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.

4557

"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.

4558

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4559

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4560

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4561

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4562

"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.

4563

# Default is false.

4564

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4565

"A String",

4566

],

4567

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4568

"A String",

4569

],

4570

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4571

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4572

"A String",

4573

],

4574

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4575

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4576

"A String",

4577

],

4578

"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.

4579

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4580

"A String",

4581

],

4582

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4583

},

4584

"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.

4585

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4586

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4587

"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.

4588

"httpStatus": 42, # The HTTP status code used to abort the request.

4589

# The value must be between 200 and 599 inclusive.

4590

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4591

# The value must be between 0.0 and 100.0 inclusive.

4592

},

4593

"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.

4594

"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.

4595

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4596

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4597

},

4598

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4599

# The value must be between 0.0 and 100.0 inclusive.

4600

},

4601

},

4602

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4603

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4604

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4605

},

4606

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4607

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4608

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4609

"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.

4610

# 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.

4611

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4612

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4613

},

4614

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4615

# - 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.

4616

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4617

# -

4618

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4619

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4620

# - 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.

4621

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4622

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4623

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4624

# - 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.

4629

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4630

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4631

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4632

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4633

},

4634

"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]

4635

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4636

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4637

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4638

# The value must be between 1 and 255 characters.

4639

"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.

4640

# The value must be between 1 and 1024 characters.

4641

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4642

"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-zero number.

4643

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4644

{ # 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

4645

"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.

4646

"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.

4647

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4648

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4649

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4650

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4651

{ # Specification determining how headers are added to requests or responses.

4652

"headerName": "A String", # The name of the header.

4653

"headerValue": "A String", # The value of the header to add.

4654

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4655

# The default value is false.

4656

},

4657

],

4658

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4659

"A String",

4660

],

4661

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4662

{ # Specification determining how headers are added to requests or responses.

4663

"headerName": "A String", # The name of the header.

4664

"headerValue": "A String", # The value of the header to add.

4665

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4666

# The default value is false.

4667

},

4668

],

4669

"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) .

4674

# 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.

4675

# 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.

4680

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4681

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4682

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4683

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4684

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4685

# The value must be between 1 and 255 characters.

4686

"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.

4687

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4688

# The default is set to false.

4689

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4690

# 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.

4691

# The value must be between 1 and 1024 characters.

4692

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4693

# 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.

4694

# The value must be between 1 and 1024 characters.

4695

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4696

# Supported values are:

4697

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4698

# - FOUND, which corresponds to 302.

4699

# - SEE_OTHER which corresponds to 303.

4700

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4701

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4702

"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.

4703

# 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.

4710

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4711

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4712

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4713

{ # Message for the expected URL mappings.

4714

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4715

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4716

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4717

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

4718

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4719

},

4720

],

4721

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4722

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4723

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.

4724

4725

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.

4726

4727

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4728

4729

Returns:

4730

An object of the form:

4731

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4732

{ # Represents an Operation resource.

4733

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4734

# Google Compute Engine has three Operation resources:

4735

#

4736

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4737

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4738

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4739

#

4740

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4741

# - For global operations, use the `globalOperations` resource.

4742

# - For regional operations, use the `regionOperations` resource.

4743

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4744

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4745

# 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]

4746

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4747

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4748

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4749

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4750

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4751

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4752

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4753

"code": "A String", # [Output Only] The error type identifier for this error.

4754

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4755

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4756

},

4757

],

4758

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4759

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4760

"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.

4761

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4762

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4763

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4764

"name": "A String", # [Output Only] Name of the operation.

4765

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4766

"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.

4767

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4768

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4769

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4770

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4771

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4772

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4773

"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.

4774

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4775

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4776

{

4777

"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.

4778

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4779

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4780

{

4781

"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).

4782

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4783

},

4784

],

4785

"message": "A String", # [Output Only] A human-readable description of the warning code.

4786

},

4787

],

4788

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4793

<code class="details" id="update">update(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

4794

<pre>Updates the specified UrlMap resource with the data included in the request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4795

4796

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

4797

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4798

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4799

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4800

The object takes the form of:

4801

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4802

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4803

#

4804

# Google Compute Engine has two URL Map resources:

4805

#

4806

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4807

#

4808

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4809

#

4810

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4811

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4812

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

4813

#

4814

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

4815

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4816

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4817

#

4818

# 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.

4819

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4820

"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.

4821

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4822

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4823

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4824

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4825

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4826

"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.

4827

# Default is false.

4828

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4829

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4830

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4831

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4832

"A String",

4833

],

4834

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4835

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4836

"A String",

4837

],

4838

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4839

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4840

"A String",

4841

],

4842

"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.

4843

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4844

"A String",

4845

],

4846

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4847

},

4848

"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.

4849

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4850

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4851

"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.

4852

"httpStatus": 42, # The HTTP status code used to abort the request.

4853

# The value must be between 200 and 599 inclusive.

4854

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4855

# The value must be between 0.0 and 100.0 inclusive.

4856

},

4857

"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.

4858

"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.

4859

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4860

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4861

},

4862

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4863

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4864

},

4865

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4866

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4867

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4868

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4869

},

4870

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4871

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4872

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4873

"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.

4874

# 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.

4875

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4876

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4877

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4878

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4879

# - 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.

4880

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4881

# -

4882

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4883

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4884

# - 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.

4885

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4886

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4887

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4888

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4889

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4890

],

4891

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4892

"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.

4893

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4894

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4895

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4896

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4897

},

4898

"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]

4899

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4900

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4902

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4905

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

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-zero number.

4907

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4912

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4913

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4914

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4915

{ # Specification determining how headers are added to requests or responses.

4916

"headerName": "A String", # The name of the header.

4917

"headerValue": "A String", # The value of the header to add.

4918

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4919

# The default value is false.

4920

},

4921

],

4922

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4923

"A String",

4924

],

4925

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4926

{ # Specification determining how headers are added to requests or responses.

4927

"headerName": "A String", # The name of the header.

4928

"headerValue": "A String", # The value of the header to add.

4929

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4930

# The default value is false.

4931

},

4932

],

4933

"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) .

4938

# 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.

4939

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4940

},

4941

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4942

},

4943

"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.

4944

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4945

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4946

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4947

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4948

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4949

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4950

# The value must be between 1 and 255 characters.

4951

"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.

4952

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4953

# The default is set to false.

4954

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4955

# 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.

4956

# The value must be between 1 and 1024 characters.

4957

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4958

# 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.

4959

# The value must be between 1 and 1024 characters.

4960

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4961

# Supported values are:

4962

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4963

# - FOUND, which corresponds to 302.

4964

# - SEE_OTHER which corresponds to 303.

4965

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4966

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4967

"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.

4968

# The default is set to false.

4969

},

4970

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4971

"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.

4972

#

4973

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4974

"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.

4975

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

4976

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4977

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4978

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4979

{ # Specification determining how headers are added to requests or responses.

4980

"headerName": "A String", # The name of the header.

4981

"headerValue": "A String", # The value of the header to add.

4982

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4983

# The default value is false.

4984

},

4985

],

4986

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4987

"A String",

4988

],

4989

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4990

{ # Specification determining how headers are added to requests or responses.

4991

"headerName": "A String", # The name of the header.

4992

"headerValue": "A String", # The value of the header to add.

4993

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4994

# The default value is false.

4995

},

4996

],

4997

"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.

5002

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5003

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5004

"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 ..

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5005

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5006

"A String",

5007

],

5008

"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.

5009

},

5010

],

5011

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5012

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5013

"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.

5014

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5015

{ # 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.

5016

"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.

5017

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5018

# 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]

5019

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5020

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5021

"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.

5022

# Default is false.

5023

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5024

"A String",

5025

],

5026

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5027

"A String",

5028

],

5029

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5030

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5031

"A String",

5032

],

5033

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5034

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5035

"A String",

5036

],

5037

"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.

5038

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5039

"A String",

5040

],

5041

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5042

},

5043

"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.

5044

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5045

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5046

"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.

5047

"httpStatus": 42, # The HTTP status code used to abort the request.

5048

# The value must be between 200 and 599 inclusive.

5049

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5050

# The value must be between 0.0 and 100.0 inclusive.

5051

},

5052

"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.

5053

"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.

5054

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5055

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5056

},

5057

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5058

# The value must be between 0.0 and 100.0 inclusive.

5059

},

5060

},

5061

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5062

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5063

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5064

},

5065

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5066

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5067

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5068

"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.

5069

# 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.

5070

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5071

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5072

},

5073

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5074

# - 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.

5075

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5076

# -

5077

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5078

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5079

# - 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.

5080

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5081

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5082

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5083

# - 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.

5088

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5089

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5090

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5091

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5092

},

5093

"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]

5094

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5095

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5096

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5097

# The value must be between 1 and 255 characters.

5098

"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.

5099

# The value must be between 1 and 1024 characters.

5100

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5101

"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-zero number.

5102

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5103

{ # 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

5104

"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.

5105

"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.

5106

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5107

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5108

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5109

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5110

{ # Specification determining how headers are added to requests or responses.

5111

"headerName": "A String", # The name of the header.

5112

"headerValue": "A String", # The value of the header to add.

5113

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5114

# The default value is false.

5115

},

5116

],

5117

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5118

"A String",

5119

],

5120

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5121

{ # Specification determining how headers are added to requests or responses.

5122

"headerName": "A String", # The name of the header.

5123

"headerValue": "A String", # The value of the header to add.

5124

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5125

# The default value is false.

5126

},

5127

],

5128

"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) .

5133

# 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.

5134

# 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:

5139

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

5140

# - compute/v1/projects/project/global/backendServices/backendService

5141

# - 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.

5142

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5143

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

5144

# - compute.backendBuckets.use

5145

# - compute.backendServices.use

5146

"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.

5147

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5148

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5149

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5150

# The value must be between 1 and 255 characters.

5151

"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.

5152

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5153

# The default is set to false.

5154

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5155

# 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.

5156

# The value must be between 1 and 1024 characters.

5157

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5158

# 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.

5159

# The value must be between 1 and 1024 characters.

5160

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5161

# Supported values are:

5162

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5163

# - FOUND, which corresponds to 302.

5164

# - SEE_OTHER which corresponds to 303.

5165

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5166

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5167

"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.

5168

# The default is set to false.

5169

},

5170

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5171

"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.

5172

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5173

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5174

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5175

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5176

{ # Specification determining how headers are added to requests or responses.

5177

"headerName": "A String", # The name of the header.

5178

"headerValue": "A String", # The value of the header to add.

5179

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5180

# The default value is false.

5181

},

5182

],

5183

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5184

"A String",

5185

],

5186

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5187

{ # Specification determining how headers are added to requests or responses.

5188

"headerName": "A String", # The name of the header.

5189

"headerValue": "A String", # The value of the header to add.

5190

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5191

# The default value is false.

5192

},

5193

],

5194

"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.

5199

"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.

5200

# 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.

5201

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5202

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5203

"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.

5204

"A String",

5205

],

5206

"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.

5207

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5208

# 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]

5209

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5210

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5211

"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.

5212

# Default is false.

5213

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5214

"A String",

5215

],

5216

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5217

"A String",

5218

],

5219

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5220

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5221

"A String",

5222

],

5223

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5224

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5225

"A String",

5226

],

5227

"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.

5228

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5229

"A String",

5230

],

5231

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5232

},

5233

"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.

5234

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5235

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5236

"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.

5237

"httpStatus": 42, # The HTTP status code used to abort the request.

5238

# The value must be between 200 and 599 inclusive.

5239

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5240

# The value must be between 0.0 and 100.0 inclusive.

5241

},

5242

"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.

5243

"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.

5244

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5245

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5246

},

5247

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5248

# The value must be between 0.0 and 100.0 inclusive.

5249

},

5250

},

5251

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5252

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5253

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5254

},

5255

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5256

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5257

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5258

"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.

5259

# 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.

5260

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5261

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5262

},

5263

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5264

# - 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.

5265

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5266

# -

5267

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5268

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5269

# - 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.

5270

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5271

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5272

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5273

# - 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.

5278

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5279

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5280

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5281

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5282

},

5283

"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]

5284

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5285

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5286

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5287

# The value must be between 1 and 255 characters.

5288

"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.

5289

# The value must be between 1 and 1024 characters.

5290

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5291

"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-zero number.

5292

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5293

{ # 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

5294

"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.

5295

"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.

5296

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5297

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5298

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5299

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5300

{ # Specification determining how headers are added to requests or responses.

5301

"headerName": "A String", # The name of the header.

5302

"headerValue": "A String", # The value of the header to add.

5303

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5304

# The default value is false.

5305

},

5306

],

5307

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5308

"A String",

5309

],

5310

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5311

{ # Specification determining how headers are added to requests or responses.

5312

"headerName": "A String", # The name of the header.

5313

"headerValue": "A String", # The value of the header to add.

5314

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5315

# The default value is false.

5316

},

5317

],

5318

"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) .

5323

# 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.

5324

# 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.

5329

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5330

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5331

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5332

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5333

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5334

# The value must be between 1 and 255 characters.

5335

"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.

5336

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5337

# The default is set to false.

5338

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5339

# 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.

5340

# The value must be between 1 and 1024 characters.

5341

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5342

# 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.

5343

# The value must be between 1 and 1024 characters.

5344

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5345

# Supported values are:

5346

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5347

# - FOUND, which corresponds to 302.

5348

# - SEE_OTHER which corresponds to 303.

5349

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5350

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5351

"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.

5352

# 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.

5357

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5358

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5359

"description": "A String", # The short description conveying the intent of this routeRule.

5360

# The description can have a maximum length of 1024 characters.

5361

"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.

5362

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5363

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5364

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5365

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5366

{ # Specification determining how headers are added to requests or responses.

5367

"headerName": "A String", # The name of the header.

5368

"headerValue": "A String", # The value of the header to add.

5369

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5370

# The default value is false.

5371

},

5372

],

5373

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5374

"A String",

5375

],

5376

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5377

{ # Specification determining how headers are added to requests or responses.

5378

"headerName": "A String", # The name of the header.

5379

"headerValue": "A String", # The value of the header to add.

5380

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5381

# The default value is false.

5382

},

5383

],

5384

"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.

5385

"A String",

5386

],

5387

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5388

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5389

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5390

"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.

5391

# fullPathMatch must be between 1 and 1024 characters.

5392

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5393

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5394

{ # matchRule criteria for request header matches.

5395

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5396

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5397

"headerName": "A String", # The name of the HTTP header to match.

5398

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5399

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5400

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5401

"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.

5402

# The default setting is false.

5403

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5404

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5405

"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.

5406

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5407

"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.

5408

# For example for a range [-5, 0]

5409

# - -3 will match.

5410

# - 0 will not match.

5411

# - 0.25 will not match.

5412

# - -3someString will not match.

5413

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5414

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5415

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5416

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5417

},

5418

"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

5419

# 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.

5420

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5421

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5422

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5423

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5424

},

5425

],

5426

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5427

# The default value is false.

5428

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5429

# Not supported when the URL map is bound to target gRPC proxy.

5430

"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. When there is a match, the relevant routing configuration is made available to those proxies.

5431

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5432

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5433

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5434

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5435

{ # 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.

5436

# 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.

5437

# 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.

5438

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5439

# This list must not be empty and can have at the most 64 entries.

5440

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5441

"name": "A String", # Name of metadata label.

5442

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5443

"value": "A String", # The value of the label must match the specified value.

5444

# value can have a maximum length of 1024 characters.

5445

},

5446

],

5447

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5448

# Supported values are:

5449

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5450

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5451

},

5452

],

5453

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5454

# The value must be between 1 and 1024 characters.

5455

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5456

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5457

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5458

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5459

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5460

# Only one of presentMatch, exactMatch or regexMatch must be set.

5461

"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.

5462

"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.

5463

# Only one of presentMatch, exactMatch or regexMatch must be set.

5464

"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

5465

# Only one of presentMatch, exactMatch or regexMatch must be set.

5466

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5467

},

5468

],

5469

"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

5470

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5471

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5472

},

5473

],

5474

"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.

5475

# 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.

5476

# 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.

5477

"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.

5478

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5479

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5480

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5481

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5482

"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.

5483

# Default is false.

5484

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5485

"A String",

5486

],

5487

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5488

"A String",

5489

],

5490

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5491

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5492

"A String",

5493

],

5494

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5495

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5496

"A String",

5497

],

5498

"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.

5499

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5500

"A String",

5501

],

5502

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5503

},

5504

"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.

5505

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5506

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5507

"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.

5508

"httpStatus": 42, # The HTTP status code used to abort the request.

5509

# The value must be between 200 and 599 inclusive.

5510

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5511

# The value must be between 0.0 and 100.0 inclusive.

5512

},

5513

"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.

5514

"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.

5515

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5516

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5517

},

5518

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5519

# The value must be between 0.0 and 100.0 inclusive.

5520

},

5521

},

5522

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5523

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5524

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5525

},

5526

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5527

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5528

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5529

"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.

5530

# 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.

5531

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5532

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5533

},

5534

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5535

# - 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.

5536

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5537

# -

5538

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5539

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5540

# - 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.

5541

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5542

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5543

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5544

# - 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.

5549

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5550

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5551

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5552

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5553

},

5554

"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]

5555

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5556

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5557

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5558

# The value must be between 1 and 255 characters.

5559

"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.

5560

# The value must be between 1 and 1024 characters.

5561

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5562

"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-zero number.

5563

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5564

{ # 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

5565

"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.

5566

"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.

5567

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5568

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5569

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5570

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5571

{ # Specification determining how headers are added to requests or responses.

5572

"headerName": "A String", # The name of the header.

5573

"headerValue": "A String", # The value of the header to add.

5574

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5575

# The default value is false.

5576

},

5577

],

5578

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5579

"A String",

5580

],

5581

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5582

{ # Specification determining how headers are added to requests or responses.

5583

"headerName": "A String", # The name of the header.

5584

"headerValue": "A String", # The value of the header to add.

5585

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5586

# The default value is false.

5587

},

5588

],

5589

"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) .

5594

# 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.

5595

# 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.

5600

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5601

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5602

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5603

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5604

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5605

# The value must be between 1 and 255 characters.

5606

"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.

5607

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5608

# The default is set to false.

5609

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5610

# 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.

5611

# The value must be between 1 and 1024 characters.

5612

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5613

# 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.

5614

# The value must be between 1 and 1024 characters.

5615

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5616

# Supported values are:

5617

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5618

# - FOUND, which corresponds to 302.

5619

# - SEE_OTHER which corresponds to 303.

5620

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5621

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5622

"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.

5623

# 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.

5630

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5631

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5632

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5633

{ # Message for the expected URL mappings.

5634

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5635

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5636

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5637

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

5638

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5639

},

5640

],

5641

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5642

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5643

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.

5644

5645

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.

5646

5647

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5648

5649

Returns:

5650

An object of the form:

5651

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5652

{ # Represents an Operation resource.

5653

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5654

# Google Compute Engine has three Operation resources:

5655

#

5656

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5657

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5658

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5659

#

5660

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5661

# - For global operations, use the `globalOperations` resource.

5662

# - For regional operations, use the `regionOperations` resource.

5663

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5664

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5665

# 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]

5666

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5667

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5668

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5669

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5670

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5671

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5672

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5673

"code": "A String", # [Output Only] The error type identifier for this error.

5674

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5675

"message": "A String", # [Output Only] An optional, human-readable error message.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5676

},

5677

],

5678

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5679

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5680

"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.

5681

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5682

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5683

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5684

"name": "A String", # [Output Only] Name of the operation.

5685

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5686

"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.

5687

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5688

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5689

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5690

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5691

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5692

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5693

"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.

5694

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5695

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5696

{

5697

"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.

5698

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5699

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5700

{

5701

"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).

5702

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5703

},

5704

],

5705

"message": "A String", # [Output Only] A human-readable description of the warning code.

5706

},

5707

],

5708

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5713

<code class="details" id="validate">validate(project, urlMap, body=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

5714

<pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5715

5716

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

5717

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5718

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5719

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5720

The object takes the form of:

5721

5722

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5723

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

5724

#

5725

# Google Compute Engine has two URL Map resources:

5726

#

5727

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

5728

#

5729

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

5730

#

5731

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

5732

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5733

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

5734

#

5735

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

5736

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5737

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

5738

#

5739

# 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.

5740

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5741

"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.

5742

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5743

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5744

# defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5745

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5746

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5747

"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.

5748

# Default is false.

5749

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5750

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5751

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5752

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5753

"A String",

5754

],

5755

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5756

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5757

"A String",

5758

],

5759

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5760

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5761

"A String",

5762

],

5763

"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.

5764

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5765

"A String",

5766

],

5767

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5768

},

5769

"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.

5770

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5771

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5772

"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.

5773

"httpStatus": 42, # The HTTP status code used to abort the request.

5774

# The value must be between 200 and 599 inclusive.

5775

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5776

# The value must be between 0.0 and 100.0 inclusive.

5777

},

5778

"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.

5779

"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.

5780

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5781

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5782

},

5783

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5784

# The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5785

},

5786

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5787

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5788

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5789

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5790

},

5791

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5792

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5793

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5794

"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.

5795

# 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.

5796

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5797

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5798

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5799

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5800

# - 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.

5801

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5802

# -

5803

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5804

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5805

# - 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.

5806

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5807

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5808

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5809

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5810

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5811

],

5812

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5813

"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.

5814

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5815

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5816

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5817

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5818

},

5819

"urlRewrite": { # The spec for modifying the path before sending the request to the matched backend service. # The spec to modify the URL of the request, prior to forwarding the request to the matched service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5820

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5821

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5822

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5823

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5824

"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.

5825

# The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5826

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5827

"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-zero number.

5828

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5829

{ # 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

5830

"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.

5831

"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.

5832

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5833

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5834

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5835

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5836

{ # Specification determining how headers are added to requests or responses.

5837

"headerName": "A String", # The name of the header.

5838

"headerValue": "A String", # The value of the header to add.

5839

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5840

# The default value is false.

5841

},

5842

],

5843

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5844

"A String",

5845

],

5846

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5847

{ # Specification determining how headers are added to requests or responses.

5848

"headerName": "A String", # The name of the header.

5849

"headerValue": "A String", # The value of the header to add.

5850

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5851

# The default value is false.

5852

},

5853

],

5854

"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) .

5859

# 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.

5860

# The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5861

},

5862

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

5863

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5864

"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.

5865

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5866

# defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5867

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5868

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5869

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5870

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5871

# The value must be between 1 and 255 characters.

5872

"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.

5873

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5874

# The default is set to false.

5875

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5876

# 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.

5877

# The value must be between 1 and 1024 characters.

5878

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5879

# 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.

5880

# The value must be between 1 and 1024 characters.

5881

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5882

# Supported values are:

5883

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5884

# - FOUND, which corresponds to 302.

5885

# - SEE_OTHER which corresponds to 303.

5886

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5887

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5888

"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.

5889

# The default is set to false.

5890

},

5891

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5892

"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.

5893

#

5894

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

5895

"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.

5896

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5897

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5898

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5899

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5900

{ # Specification determining how headers are added to requests or responses.

5901

"headerName": "A String", # The name of the header.

5902

"headerValue": "A String", # The value of the header to add.

5903

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5904

# The default value is false.

5905

},

5906

],

5907

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5908

"A String",

5909

],

5910

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5911

{ # Specification determining how headers are added to requests or responses.

5912

"headerName": "A String", # The name of the header.

5913

"headerValue": "A String", # The value of the header to add.

5914

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5915

# The default value is false.

5916

},

5917

],

5918

"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.

5923

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5924

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5925

"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 ..

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5926

# * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5927

"A String",

5928

],

5929

"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.

5930

},

5931

],

5932

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5933

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5934

"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.

5935

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5936

{ # 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.

5937

"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.

5938

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5939

# 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]

5940

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5941

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5942

"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.

5943

# Default is false.

5944

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5945

"A String",

5946

],

5947

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5948

"A String",

5949

],

5950

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5951

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5952

"A String",

5953

],

5954

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5955

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5956

"A String",

5957

],

5958

"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.

5959

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5960

"A String",

5961

],

5962

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5963

},

5964

"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.

5965

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5966

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5967

"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.

5968

"httpStatus": 42, # The HTTP status code used to abort the request.

5969

# The value must be between 200 and 599 inclusive.

5970

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5971

# The value must be between 0.0 and 100.0 inclusive.

5972

},

5973

"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.

5974

"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.

5975

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5976

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5977

},

5978

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5979

# The value must be between 0.0 and 100.0 inclusive.

5980

},

5981

},

5982

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5983

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5984

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5985

},

5986

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

5987

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5988

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5989

"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.

5990

# 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.

5991

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5992

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5993

},

5994

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5995

# - 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.

5996

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5997

# -

5998

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5999

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6000

# - 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.

6001

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6002

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6003

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6004

# - 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.

6009

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6010

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6011

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6012

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6013

},

6014

"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]

6015

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6016

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6017

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6018

# The value must be between 1 and 255 characters.

6019

"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.

6020

# The value must be between 1 and 1024 characters.

6021

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6022

"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-zero number.

6023

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6024

{ # 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

6025

"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.

6026

"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.

6027

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6028

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6029

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6030

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6031

{ # Specification determining how headers are added to requests or responses.

6032

"headerName": "A String", # The name of the header.

6033

"headerValue": "A String", # The value of the header to add.

6034

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6035

# The default value is false.

6036

},

6037

],

6038

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6039

"A String",

6040

],

6041

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6042

{ # Specification determining how headers are added to requests or responses.

6043

"headerName": "A String", # The name of the header.

6044

"headerValue": "A String", # The value of the header to add.

6045

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6046

# The default value is false.

6047

},

6048

],

6049

"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) .

6054

# 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.

6055

# 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:

6060

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

6061

# - compute/v1/projects/project/global/backendServices/backendService

6062

# - 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.

6063

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

6064

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

6065

# - compute.backendBuckets.use

6066

# - compute.backendServices.use

6067

"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.

6068

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6069

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6070

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6071

# The value must be between 1 and 255 characters.

6072

"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.

6073

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6074

# The default is set to false.

6075

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6076

# 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.

6077

# The value must be between 1 and 1024 characters.

6078

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6079

# 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.

6080

# The value must be between 1 and 1024 characters.

6081

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6082

# Supported values are:

6083

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6084

# - FOUND, which corresponds to 302.

6085

# - SEE_OTHER which corresponds to 303.

6086

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6087

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6088

"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.

6089

# The default is set to false.

6090

},

6091

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6092

"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.

6093

# HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6094

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6095

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6096

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6097

{ # Specification determining how headers are added to requests or responses.

6098

"headerName": "A String", # The name of the header.

6099

"headerValue": "A String", # The value of the header to add.

6100

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6101

# The default value is false.

6102

},

6103

],

6104

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6105

"A String",

6106

],

6107

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6108

{ # Specification determining how headers are added to requests or responses.

6109

"headerName": "A String", # The name of the header.

6110

"headerValue": "A String", # The value of the header to add.

6111

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6112

# The default value is false.

6113

},

6114

],

6115

"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.

6120

"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.

6121

# 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.

6122

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

6123

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

6124

"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.

6125

"A String",

6126

],

6127

"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.

6128

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6129

# 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]

6130

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6131

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6132

"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.

6133

# Default is false.

6134

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6135

"A String",

6136

],

6137

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6138

"A String",

6139

],

6140

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6141

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6142

"A String",

6143

],

6144

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6145

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6146

"A String",

6147

],

6148

"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.

6149

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6150

"A String",

6151

],

6152

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6153

},

6154

"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.

6155

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6156

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6157

"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.

6158

"httpStatus": 42, # The HTTP status code used to abort the request.

6159

# The value must be between 200 and 599 inclusive.

6160

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6161

# The value must be between 0.0 and 100.0 inclusive.

6162

},

6163

"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.

6164

"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.

6165

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6166

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6167

},

6168

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6169

# The value must be between 0.0 and 100.0 inclusive.

6170

},

6171

},

6172

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6173

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6174

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6175

},

6176

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6177

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6178

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6179

"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.

6180

# 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.

6181

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6182

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6183

},

6184

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6185

# - 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.

6186

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6187

# -

6188

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6189

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6190

# - 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.

6191

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6192

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6193

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6194

# - 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.

6199

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6200

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6201

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6202

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6203

},

6204

"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]

6205

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6206

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6207

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6208

# The value must be between 1 and 255 characters.

6209

"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.

6210

# The value must be between 1 and 1024 characters.

6211

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6212

"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-zero number.

6213

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6214

{ # 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

6215

"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.

6216

"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.

6217

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6218

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6219

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6220

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6221

{ # Specification determining how headers are added to requests or responses.

6222

"headerName": "A String", # The name of the header.

6223

"headerValue": "A String", # The value of the header to add.

6224

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6225

# The default value is false.

6226

},

6227

],

6228

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6229

"A String",

6230

],

6231

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6232

{ # Specification determining how headers are added to requests or responses.

6233

"headerName": "A String", # The name of the header.

6234

"headerValue": "A String", # The value of the header to add.

6235

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6236

# The default value is false.

6237

},

6238

],

6239

"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) .

6244

# 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.

6245

# 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.

6250

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6251

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

6252

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6253

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6254

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6255

# The value must be between 1 and 255 characters.

6256

"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.

6257

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6258

# The default is set to false.

6259

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6260

# 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.

6261

# The value must be between 1 and 1024 characters.

6262

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6263

# 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.

6264

# The value must be between 1 and 1024 characters.

6265

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6266

# Supported values are:

6267

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6268

# - FOUND, which corresponds to 302.

6269

# - SEE_OTHER which corresponds to 303.

6270

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6271

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6272

"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.

6273

# 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.

6278

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

6279

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

6280

"description": "A String", # The short description conveying the intent of this routeRule.

6281

# The description can have a maximum length of 1024 characters.

6282

"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.

6283

# The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6284

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6285

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6286

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6287

{ # Specification determining how headers are added to requests or responses.

6288

"headerName": "A String", # The name of the header.

6289

"headerValue": "A String", # The value of the header to add.

6290

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6291

# The default value is false.

6292

},

6293

],

6294

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6295

"A String",

6296

],

6297

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6298

{ # Specification determining how headers are added to requests or responses.

6299

"headerName": "A String", # The name of the header.

6300

"headerValue": "A String", # The value of the header to add.

6301

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6302

# The default value is false.

6303

},

6304

],

6305

"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.

6306

"A String",

6307

],

6308

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6309

"matchRules": [ # The list of criteria for matching attributes of a request to this routeRule. This list has OR semantics: the request matches this routeRule when any of the matchRules are satisfied. However predicates within a given matchRule have AND semantics. All predicates within a matchRule must match for the request to match the rule.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6310

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

6311

"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.

6312

# fullPathMatch must be between 1 and 1024 characters.

6313

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6314

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

6315

{ # matchRule criteria for request header matches.

6316

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

6317

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6318

"headerName": "A String", # The name of the HTTP header to match.

6319

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

6320

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6321

# When the URL map is bound to target gRPC proxy that has validateForProxyless field set to true, only non-binary user-specified custom metadata and the `content-type` header are supported. The following transport-level headers cannot be used in header matching rules: `:authority`, `:method`, `:path`, `:scheme`, `user-agent`, `accept-encoding`, `content-encoding`, `grpc-accept-encoding`, `grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`, `grpc-timeout` and `grpc-trace-bin.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6322

"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.

6323

# The default setting is false.

6324

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

6325

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6326

"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.

6327

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6328

"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.

6329

# For example for a range [-5, 0]

6330

# - -3 will match.

6331

# - 0 will not match.

6332

# - 0.25 will not match.

6333

# - -3someString will not match.

6334

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6335

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6336

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

6337

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

6338

},

6339

"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

6340

# 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.

6341

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6342

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6343

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

6344

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6345

},

6346

],

6347

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

6348

# The default value is false.

6349

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6350

# Not supported when the URL map is bound to target gRPC proxy.

6351

"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. When there is a match, the relevant routing configuration is made available to those proxies.

6352

# 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. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6353

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

6354

# metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6355

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6356

{ # 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.

6357

# 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.

6358

# 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.

6359

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

6360

# This list must not be empty and can have at the most 64 entries.

6361

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

6362

"name": "A String", # Name of metadata label.

6363

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

6364

"value": "A String", # The value of the label must match the specified value.

6365

# value can have a maximum length of 1024 characters.

6366

},

6367

],

6368

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

6369

# Supported values are:

6370

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

6371

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

6372

},

6373

],

6374

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

6375

# The value must be between 1 and 1024 characters.

6376

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6377

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6378

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6379

{ # HttpRouteRuleMatch criteria for a request's query parameter.

6380

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

6381

# Only one of presentMatch, exactMatch or regexMatch must be set.

6382

"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.

6383

"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.

6384

# Only one of presentMatch, exactMatch or regexMatch must be set.

6385

"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

6386

# Only one of presentMatch, exactMatch or regexMatch must be set.

6387

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

6388

},

6389

],

6390

"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

6391

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6392

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6393

},

6394

],

6395

"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.

6396

# 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.

6397

# 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.

6398

"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.

6399

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6400

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6401

"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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6402

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6403

"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.

6404

# Default is false.

6405

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6406

"A String",

6407

],

6408

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6409

"A String",

6410

],

6411

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6412

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6413

"A String",

6414

],

6415

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6416

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6417

"A String",

6418

],

6419

"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.

6420

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6421

"A String",

6422

],

6423

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6424

},

6425

"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.

6426

# timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6427

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6428

"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.

6429

"httpStatus": 42, # The HTTP status code used to abort the request.

6430

# The value must be between 200 and 599 inclusive.

6431

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6432

# The value must be between 0.0 and 100.0 inclusive.

6433

},

6434

"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.

6435

"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.

6436

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6437

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6438

},

6439

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6440

# The value must be between 0.0 and 100.0 inclusive.

6441

},

6442

},

6443

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6444

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6445

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6446

},

6447

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6448

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6449

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6450

"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.

6451

# 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.

6452

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6453

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6454

},

6455

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6456

# - 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.

6457

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6458

# -

6459

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6460

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6461

# - 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.

6462

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6463

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6464

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6465

# - 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.

6470

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6471

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6472

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6473

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6474

},

6475

"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]

6476

# urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6477

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6478

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6479

# The value must be between 1 and 255 characters.

6480

"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.

6481

# The value must be between 1 and 1024 characters.

6482

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6483

"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-zero number.

6484

# Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6485

{ # 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

6486

"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.

6487

"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.

6488

# headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6489

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6490

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6491

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6492

{ # Specification determining how headers are added to requests or responses.

6493

"headerName": "A String", # The name of the header.

6494

"headerValue": "A String", # The value of the header to add.

6495

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6496

# The default value is false.

6497

},

6498

],

6499

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6500

"A String",

6501

],

6502

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6503

{ # Specification determining how headers are added to requests or responses.

6504

"headerName": "A String", # The name of the header.

6505

"headerValue": "A String", # The value of the header to add.

6506

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6507

# The default value is false.

6508

},

6509

],

6510

"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) .

6515

# 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.

6516

# 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.

6521

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6522

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

6523

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6524

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6525

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6526

# The value must be between 1 and 255 characters.

6527

"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.

6528

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6529

# The default is set to false.

6530

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6531

# 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.

6532

# The value must be between 1 and 1024 characters.

6533

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6534

# 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.

6535

# The value must be between 1 and 1024 characters.

6536

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6537

# Supported values are:

6538

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6539

# - FOUND, which corresponds to 302.

6540

# - SEE_OTHER which corresponds to 303.

6541

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6542

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6543

"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.

6544

# 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.

6551

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6552

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6553

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6554

{ # Message for the expected URL mappings.

6555

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6556

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6557

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6558

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

6559

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6560

},

6561

],

6562

},

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

}

Returns:

An object of the form:

6568

6569

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6570

"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.

6575

"testFailures": [

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

6576

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

6577

"actualService": "A String", # BackendService or BackendBucket returned by load balancer.

6578

"expectedService": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

6579

"host": "A String", # Host portion of the URL.

6580

"path": "A String", # Path portion including query parameters in the URL.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

6581

},

6582

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6583

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

Craig Citro