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

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

[diff] [blame]

79

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

80

81

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

82

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

83

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>

Sai Cheemalapati

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

Sai Cheemalapati

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

Sai Cheemalapati

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

Sai Cheemalapati

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

Sai Cheemalapati

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

Sai Cheemalapati

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

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

Sai Cheemalapati

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

[diff] [blame]

109

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

110

Dan O'Meara

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

[diff] [blame]

111

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

Sai Cheemalapati

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

[diff] [blame]

112

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

113

Dan O'Meara

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

[diff] [blame]

114

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

Sai Cheemalapati

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

[diff] [blame]

115

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

116

<h3>Method Details</h3>

117

Dmitry Frenkel

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

[diff] [blame^]

118

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

Bu Sun Kim

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

[diff] [blame]

119

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

120

121

Args:

122

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

Dan O'Meara

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

[diff] [blame]

123

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

Bu Sun Kim

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

[diff] [blame]

124

Dan O'Meara

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

Dan O'Meara

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

[diff] [blame]

127

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

Bu Sun Kim

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

[diff] [blame]

128

Bu Sun Kim

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

[diff] [blame]

129

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]

130

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]

131

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

132

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

133

134

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.

135

136

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

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

140

Returns:

141

An object of the form:

142

143

{

Bu Sun Kim

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

[diff] [blame]

144

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

145

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

146

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

147

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

Dan O'Meara

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

[diff] [blame]

148

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

149

#

150

# Google Compute Engine has two URL Map resources:

151

#

152

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

153

#

154

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

155

#

156

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

157

#

Dmitry Frenkel

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

[diff] [blame^]

158

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

159

#

160

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

161

#

Bu Sun Kim

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

[diff] [blame]

162

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

163

#

164

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

165

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

166

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

167

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

168

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

169

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

170

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

171

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

Bu Sun Kim

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

[diff] [blame]

172

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

173

# Default is false.

174

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

175

"A String",

Bu Sun Kim

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

[diff] [blame]

176

],

Bu Sun Kim

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

[diff] [blame]

177

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

178

"A String",

179

],

180

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

181

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

182

"A String",

183

],

184

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

185

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

186

"A String",

187

],

188

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

189

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

190

"A String",

191

],

192

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

193

},

194

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

195

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

196

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

197

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

198

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

199

# The value must be between 200 and 599 inclusive.

200

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

201

# The value must be between 0.0 and 100.0 inclusive.

202

},

203

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

204

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

205

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

206

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

207

},

208

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

209

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

210

},

211

},

Bu Sun Kim

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

[diff] [blame]

212

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

213

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

214

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

215

},

216

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

217

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

218

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

219

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

220

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

221

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

222

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

Bu Sun Kim

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

[diff] [blame]

223

},

Bu Sun Kim

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

[diff] [blame]

224

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

225

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

226

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

227

# -

228

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

229

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

230

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

231

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

232

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

233

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

234

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

235

"A String",

Bu Sun Kim

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

[diff] [blame]

236

],

237

},

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

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

241

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

242

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

243

},

244

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

245

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

246

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

247

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

Bu Sun Kim

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

[diff] [blame]

248

# The value must be between 1 and 255 characters.

Bu Sun Kim

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

[diff] [blame]

249

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

250

# The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

251

},

Dmitry Frenkel

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

[diff] [blame^]

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

# The default value is false.

266

},

267

],

268

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

269

"A String",

270

],

271

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

272

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

273

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

274

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

275

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

276

# The default value is false.

277

},

278

],

279

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

284

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

285

# The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

286

},

287

],

Bu Sun Kim

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

[diff] [blame]

288

},

Bu Sun Kim

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

[diff] [blame]

289

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

290

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

Dmitry Frenkel

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

[diff] [blame^]

291

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

292

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

293

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

Dmitry Frenkel

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

[diff] [blame^]

294

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

Bu Sun Kim

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

[diff] [blame]

295

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

296

# The value must be between 1 and 255 characters.

297

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

298

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

299

# The default is set to false.

300

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

301

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

302

# The value must be between 1 and 1024 characters.

303

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

304

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

305

# The value must be between 1 and 1024 characters.

306

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

307

# Supported values are:

308

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

309

# - FOUND, which corresponds to 302.

310

# - SEE_OTHER which corresponds to 303.

311

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

312

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

313

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

314

# The default is set to false.

315

},

316

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

317

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

318

#

319

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

320

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

321

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

Dmitry Frenkel

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

[diff] [blame^]

322

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

323

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

324

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

325

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

326

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

327

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

328

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

329

# The default value is false.

330

},

331

],

332

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

333

"A String",

334

],

335

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

336

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

337

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

338

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

339

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

340

# The default value is false.

341

},

342

],

343

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

348

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

349

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

350

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

351

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

352

"A String",

353

],

354

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

355

},

356

],

357

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

358

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

359

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

360

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

361

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

362

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

363

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

366

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

Bu Sun Kim

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

[diff] [blame]

367

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

368

# Default is false.

369

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

370

"A String",

371

],

372

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

373

"A String",

374

],

375

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

376

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

377

"A String",

378

],

379

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

380

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

381

"A String",

382

],

383

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

384

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

385

"A String",

386

],

387

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

388

},

389

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

390

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

391

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

392

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

393

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

394

# The value must be between 200 and 599 inclusive.

395

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

396

# The value must be between 0.0 and 100.0 inclusive.

397

},

398

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

399

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

400

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

401

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

402

},

403

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

404

# The value must be between 0.0 and 100.0 inclusive.

405

},

406

},

407

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

408

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

409

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

410

},

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

},

419

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

420

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

421

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

422

# -

423

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

424

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

425

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

426

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

427

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

428

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

429

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

434

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

435

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

436

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

437

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

438

},

439

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

440

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

441

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

442

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

443

# The value must be between 1 and 255 characters.

444

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

445

# The value must be between 1 and 1024 characters.

446

},

Dmitry Frenkel

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

[diff] [blame^]

447

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

448

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

449

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

450

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

451

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

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

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

460

# The default value is false.

461

},

462

],

463

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

464

"A String",

465

],

466

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

467

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

468

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

469

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

470

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

471

# The default value is false.

472

},

473

],

474

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

479

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

480

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

485

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

486

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

487

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

488

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

489

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

490

# - compute.backendBuckets.use

491

# - compute.backendServices.use

492

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

493

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

Dmitry Frenkel

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

[diff] [blame^]

494

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

Bu Sun Kim

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

[diff] [blame]

495

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

496

# The value must be between 1 and 255 characters.

497

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

498

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

499

# The default is set to false.

500

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

501

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

502

# The value must be between 1 and 1024 characters.

503

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

504

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

505

# The value must be between 1 and 1024 characters.

506

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

507

# Supported values are:

508

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

509

# - FOUND, which corresponds to 302.

510

# - SEE_OTHER which corresponds to 303.

511

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

512

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

513

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

514

# The default is set to false.

515

},

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

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

525

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

526

# The default value is false.

527

},

528

],

529

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

530

"A String",

531

],

532

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

533

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

534

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

535

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

536

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

537

# The default value is false.

538

},

539

],

540

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

545

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

546

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

547

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

548

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

549

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

550

"A String",

551

],

552

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

553

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

554

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

555

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

556

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

Bu Sun Kim

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

[diff] [blame]

557

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

558

# Default is false.

559

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

560

"A String",

561

],

562

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

563

"A String",

564

],

565

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

566

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

567

"A String",

568

],

569

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

570

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

571

"A String",

572

],

573

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

574

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

575

"A String",

576

],

577

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

578

},

579

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

580

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

581

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

582

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

583

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

584

# The value must be between 200 and 599 inclusive.

585

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

586

# The value must be between 0.0 and 100.0 inclusive.

587

},

588

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

589

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

590

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

591

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

592

},

593

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

594

# The value must be between 0.0 and 100.0 inclusive.

595

},

596

},

597

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

598

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

599

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

600

},

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

},

609

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

610

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

611

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

612

# -

613

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

614

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

615

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

616

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

617

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

618

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

619

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

624

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

625

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

626

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

627

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

628

},

629

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

630

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

631

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

632

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

633

# The value must be between 1 and 255 characters.

634

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

635

# The value must be between 1 and 1024 characters.

636

},

Dmitry Frenkel

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

[diff] [blame^]

637

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

638

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

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

# The default value is false.

651

},

652

],

653

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

654

"A String",

655

],

656

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

657

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

658

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

659

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

660

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

661

# The default value is false.

662

},

663

],

664

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

669

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

670

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

675

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

676

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

677

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

Dmitry Frenkel

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

[diff] [blame^]

678

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

Bu Sun Kim

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

[diff] [blame]

679

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

680

# The value must be between 1 and 255 characters.

681

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

682

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

683

# The default is set to false.

684

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

685

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

686

# The value must be between 1 and 1024 characters.

687

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

688

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

689

# The value must be between 1 and 1024 characters.

690

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

691

# Supported values are:

692

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

693

# - FOUND, which corresponds to 302.

694

# - SEE_OTHER which corresponds to 303.

695

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

696

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

697

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

698

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

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

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

711

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

712

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

713

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

714

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

715

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

716

# The default value is false.

717

},

718

],

719

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

720

"A String",

721

],

722

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

723

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

724

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

725

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

726

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

727

# The default value is false.

728

},

729

],

730

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

731

"A String",

732

],

733

},

Dmitry Frenkel

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

[diff] [blame^]

734

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

735

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

736

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

737

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

738

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

739

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

740

},

741

],

742

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

743

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

744

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

745

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

746

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

747

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

748

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

749

},

750

],

751

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

752

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

753

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

754

# fullPathMatch must be between 1 and 1024 characters.

755

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

756

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

757

{ # matchRule criteria for request header matches.

758

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

759

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

760

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

761

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

762

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

Dmitry Frenkel

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

[diff] [blame^]

763

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

764

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

765

# The default setting is false.

766

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

767

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

768

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

769

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

770

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

771

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

772

# - -3 will match.

773

# - 0 will not match.

774

# - 0.25 will not match.

775

# - -3someString will not match.

776

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

777

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

778

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

779

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

780

},

781

"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

782

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

783

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

784

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

785

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

786

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

787

},

788

],

789

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

790

# The default value is false.

791

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

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

[diff] [blame^]

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

803

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

804

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

805

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

806

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

807

# value can have a maximum length of 1024 characters.

808

},

809

],

810

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

811

# Supported values are:

812

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

813

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

814

},

815

],

816

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

817

# The value must be between 1 and 1024 characters.

818

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

819

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

820

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

Bu Sun Kim

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

[diff] [blame]

821

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

822

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

823

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

824

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

825

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

826

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

827

"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

828

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

829

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

830

},

831

],

832

"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

833

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

834

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

835

},

836

],

837

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

838

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

839

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

840

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

841

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

Dmitry Frenkel

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

[diff] [blame^]

842

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

843

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

844

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

Bu Sun Kim

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

[diff] [blame]

845

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

846

# Default is false.

847

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

848

"A String",

849

],

850

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

851

"A String",

852

],

853

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

854

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

855

"A String",

856

],

857

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

858

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

859

"A String",

860

],

861

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

862

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

863

"A String",

864

],

865

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

866

},

867

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

868

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

869

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

870

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

871

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

872

# The value must be between 200 and 599 inclusive.

873

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

874

# The value must be between 0.0 and 100.0 inclusive.

875

},

876

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

877

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

878

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

879

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

880

},

881

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

882

# The value must be between 0.0 and 100.0 inclusive.

883

},

884

},

885

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

886

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

887

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

888

},

889

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

890

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

891

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

892

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

893

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

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

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

898

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

899

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

900

# -

901

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

902

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

903

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

904

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

905

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

906

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

907

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

912

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

913

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

914

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

915

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

916

},

917

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

918

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

919

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

920

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

921

# The value must be between 1 and 255 characters.

922

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

923

# The value must be between 1 and 1024 characters.

924

},

Dmitry Frenkel

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

[diff] [blame^]

925

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

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

937

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

938

# The default value is false.

939

},

940

],

941

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

942

"A String",

943

],

944

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

945

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

946

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

947

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

948

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

949

# The default value is false.

950

},

951

],

952

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

957

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

958

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

963

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

964

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

965

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

Dmitry Frenkel

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

[diff] [blame^]

966

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

Bu Sun Kim

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

[diff] [blame]

967

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

968

# The value must be between 1 and 255 characters.

969

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

970

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

971

# The default is set to false.

972

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

973

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

974

# The value must be between 1 and 1024 characters.

975

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

976

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

977

# The value must be between 1 and 1024 characters.

978

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

979

# Supported values are:

980

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

981

# - FOUND, which corresponds to 302.

982

# - SEE_OTHER which corresponds to 303.

983

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

984

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

985

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

986

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

993

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

994

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

995

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

996

{ # Message for the expected URL mappings.

997

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

Dmitry Frenkel

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

[diff] [blame^]

998

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

999

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

Dmitry Frenkel

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

[diff] [blame^]

1000

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

1001

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

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

[diff] [blame]

1002

},

1003

],

1004

},

Bu Sun Kim

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

[diff] [blame]

1005

],

Bu Sun Kim

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

[diff] [blame]

1006

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

1007

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

1008

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

1009

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

Bu Sun Kim

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

[diff] [blame]

1010

{

Bu Sun Kim

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

[diff] [blame]

1011

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

1012

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

1013

},

1014

],

Bu Sun Kim

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

[diff] [blame]

1015

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

1016

},

1017

},

1018

},

Bu Sun Kim

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

[diff] [blame]

1019

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

1020

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

1021

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

Dmitry Frenkel

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

[diff] [blame^]

1022

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

1023

"A String",

1024

],

Bu Sun Kim

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

[diff] [blame]

1025

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

1026

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

1027

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

1028

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

Bu Sun Kim

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

[diff] [blame]

1029

{

Bu Sun Kim

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

[diff] [blame]

1030

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

1031

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

1032

},

1033

],

Bu Sun Kim

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

[diff] [blame]

1034

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

1035

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

1041

<pre>Retrieves the next page of results.

1042

1043

Args:

1044

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

1045

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

1046

1047

Returns:

Bu Sun Kim

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

[diff] [blame]

1048

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

Bu Sun Kim

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

[diff] [blame]

1049

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

1054

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

1055

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1059

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

Sai Cheemalapati

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

[diff] [blame]

1060

<pre>Deletes the specified UrlMap resource.

1061

1062

Args:

1063

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

1064

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

Bu Sun Kim

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

[diff] [blame]

1065

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.

1066

1067

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.

1068

1069

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

Sai Cheemalapati

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

[diff] [blame]

1070

1071

Returns:

1072

An object of the form:

1073

Bu Sun Kim

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

[diff] [blame]

1074

{ # Represents an Operation resource.

1075

#

Dan O'Meara

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

[diff] [blame]

1076

# Google Compute Engine has three Operation resources:

1077

#

1078

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

1079

#

Bu Sun Kim

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

[diff] [blame]

1080

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

1081

#

1082

# Operations can be global, regional or zonal.

Dan O'Meara

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

[diff] [blame]

1083

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

1084

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

1085

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

Bu Sun Kim

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

[diff] [blame]

1086

#

Dan O'Meara

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

[diff] [blame]

1087

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

1088

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

1089

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

1090

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

1091

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

1092

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

1093

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

Sai Cheemalapati

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

[diff] [blame]

1094

{

Bu Sun Kim

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

[diff] [blame]

1095

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

1096

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

1097

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

Sai Cheemalapati

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

[diff] [blame]

1098

},

1099

],

1100

},

Bu Sun Kim

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

[diff] [blame]

1101

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

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

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

1112

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

1113

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

1114

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

1115

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

1116

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

1117

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

1118

{

1119

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

1120

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

1121

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

1122

{

1123

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

1124

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

1125

},

1126

],

1127

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

1128

},

1129

],

1130

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

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

Bu Sun Kim

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

[diff] [blame]

1136

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

Sai Cheemalapati

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

[diff] [blame]

1137

1138

Args:

1139

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

1140

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

1141

1142

Returns:

1143

An object of the form:

1144

Dan O'Meara

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

[diff] [blame]

1145

{ # Represents a URL Map resource.

Bu Sun Kim

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

[diff] [blame]

1146

#

1147

# Google Compute Engine has two URL Map resources:

1148

#

1149

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

1150

#

1151

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

1152

#

1153

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

1154

#

Dmitry Frenkel

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

[diff] [blame^]

1155

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

1156

#

1157

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

1158

#

Bu Sun Kim

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

[diff] [blame]

1159

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

1160

#

1161

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

1162

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

1163

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

1164

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

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

[diff] [blame]

1165

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

1166

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

1167

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

1168

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

Bu Sun Kim

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

[diff] [blame]

1169

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

1170

# Default is false.

1171

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

1172

"A String",

Bu Sun Kim

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

[diff] [blame]

1173

],

Bu Sun Kim

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

[diff] [blame]

1174

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

1175

"A String",

1176

],

1177

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

1178

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

1179

"A String",

1180

],

1181

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

1182

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

1183

"A String",

1184

],

1185

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

1186

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

1187

"A String",

1188

],

1189

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

1190

},

1191

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

1192

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

1193

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

1194

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

1195

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

1196

# The value must be between 200 and 599 inclusive.

1197

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

1198

# The value must be between 0.0 and 100.0 inclusive.

1199

},

1200

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

1201

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

1202

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

1203

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

1204

},

1205

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

1206

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1207

},

1208

},

Bu Sun Kim

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

[diff] [blame]

1209

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

1210

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

1211

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

1212

},

1213

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

1214

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

1215

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

1216

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

1217

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

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

Sai Cheemalapati

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

[diff] [blame]

1220

},

Bu Sun Kim

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

[diff] [blame]

1221

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

1222

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

1223

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

1224

# -

1225

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

1226

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

1227

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

1228

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

1229

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

1230

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

1231

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

1232

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1233

],

1234

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1235

"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.

1236

# 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^]

1237

# 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]

1238

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1239

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1240

},

1241

"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]

1242

# 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^]

1243

# 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]

1244

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1245

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1246

"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.

1247

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1248

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1249

"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.

1250

# 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]

1251

{ # 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

1252

"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.

1253

"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.

1254

# 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^]

1255

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1256

# 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]

1257

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1258

{ # Specification determining how headers are added to requests or responses.

1259

"headerName": "A String", # The name of the header.

1260

"headerValue": "A String", # The value of the header to add.

1261

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1262

# The default value is false.

1263

},

1264

],

1265

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1266

"A String",

1267

],

1268

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1269

{ # Specification determining how headers are added to requests or responses.

1270

"headerName": "A String", # The name of the header.

1271

"headerValue": "A String", # The value of the header to add.

1272

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1273

# The default value is false.

1274

},

1275

],

1276

"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) .

1281

# 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.

1282

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1283

},

1284

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1285

},

1286

"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.

1287

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1288

# 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]

1289

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

1290

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1291

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1292

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1293

# The value must be between 1 and 255 characters.

1294

"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.

1295

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1296

# The default is set to false.

1297

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1298

# 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.

1299

# The value must be between 1 and 1024 characters.

1300

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1301

# 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.

1302

# The value must be between 1 and 1024 characters.

1303

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1304

# Supported values are:

1305

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1306

# - FOUND, which corresponds to 302.

1307

# - SEE_OTHER which corresponds to 303.

1308

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1309

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1310

"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.

1311

# The default is set to false.

1312

},

1313

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1314

"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.

1315

#

1316

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

1317

"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.

1318

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1319

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1320

# 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]

1321

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1322

{ # Specification determining how headers are added to requests or responses.

1323

"headerName": "A String", # The name of the header.

1324

"headerValue": "A String", # The value of the header to add.

1325

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1326

# The default value is false.

1327

},

1328

],

1329

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1330

"A String",

1331

],

1332

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1333

{ # Specification determining how headers are added to requests or responses.

1334

"headerName": "A String", # The name of the header.

1335

"headerValue": "A String", # The value of the header to add.

1336

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1337

# The default value is false.

1338

},

1339

],

1340

"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.

1345

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

1346

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1347

"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^]

1348

# * 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]

1349

"A String",

1350

],

1351

"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.

1352

},

1353

],

1354

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

1355

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

1356

"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.

1357

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

1358

{ # 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.

1359

"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.

1360

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1361

# 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]

1362

"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^]

1363

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1364

"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.

1365

# Default is false.

1366

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1367

"A String",

1368

],

1369

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1370

"A String",

1371

],

1372

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1373

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1374

"A String",

1375

],

1376

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1377

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1378

"A String",

1379

],

1380

"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.

1381

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1382

"A String",

1383

],

1384

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1385

},

1386

"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.

1387

# 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^]

1388

# 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]

1389

"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.

1390

"httpStatus": 42, # The HTTP status code used to abort the request.

1391

# The value must be between 200 and 599 inclusive.

1392

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1393

# The value must be between 0.0 and 100.0 inclusive.

1394

},

1395

"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.

1396

"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.

1397

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1398

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1399

},

1400

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1401

# The value must be between 0.0 and 100.0 inclusive.

1402

},

1403

},

1404

"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^]

1405

# 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]

1406

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1407

},

1408

"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^]

1409

# 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]

1410

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1411

"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.

1412

# 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.

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

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1417

# - 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.

1418

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1419

# -

1420

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1421

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1422

# - 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.

1423

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1424

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1425

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1426

# - 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.

1431

# 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^]

1432

# 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]

1433

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1434

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1435

},

1436

"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]

1437

# 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^]

1438

# 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]

1439

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1440

# The value must be between 1 and 255 characters.

1441

"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.

1442

# The value must be between 1 and 1024 characters.

1443

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1444

"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.

1445

# 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]

1446

{ # 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

1447

"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.

1448

"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.

1449

# 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^]

1450

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1451

# 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]

1452

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1453

{ # Specification determining how headers are added to requests or responses.

1454

"headerName": "A String", # The name of the header.

1455

"headerValue": "A String", # The value of the header to add.

1456

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1457

# The default value is false.

1458

},

1459

],

1460

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1461

"A String",

1462

],

1463

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1464

{ # Specification determining how headers are added to requests or responses.

1465

"headerName": "A String", # The name of the header.

1466

"headerValue": "A String", # The value of the header to add.

1467

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1468

# The default value is false.

1469

},

1470

],

1471

"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) .

1476

# 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.

1477

# 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:

1482

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

1483

# - compute/v1/projects/project/global/backendServices/backendService

1484

# - 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.

1485

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

1486

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

1487

# - compute.backendBuckets.use

1488

# - compute.backendServices.use

1489

"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.

1490

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1491

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1493

# The value must be between 1 and 255 characters.

1494

"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.

1495

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1496

# The default is set to false.

1497

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1498

# 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.

1499

# The value must be between 1 and 1024 characters.

1500

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1501

# 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.

1502

# The value must be between 1 and 1024 characters.

1503

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1504

# Supported values are:

1505

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1506

# - FOUND, which corresponds to 302.

1507

# - SEE_OTHER which corresponds to 303.

1508

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1509

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1510

"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.

1511

# The default is set to false.

1512

},

1513

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

1514

"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.

1515

# 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^]

1516

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1517

# 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]

1518

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1519

{ # Specification determining how headers are added to requests or responses.

1520

"headerName": "A String", # The name of the header.

1521

"headerValue": "A String", # The value of the header to add.

1522

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1523

# The default value is false.

1524

},

1525

],

1526

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1527

"A String",

1528

],

1529

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1530

{ # Specification determining how headers are added to requests or responses.

1531

"headerName": "A String", # The name of the header.

1532

"headerValue": "A String", # The value of the header to add.

1533

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1534

# The default value is false.

1535

},

1536

],

1537

"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.

1542

"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.

1543

# 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.

1544

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

1545

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

1546

"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.

1547

"A String",

1548

],

1549

"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.

1550

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1551

# 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]

1552

"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^]

1553

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1554

"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.

1555

# Default is false.

1556

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1557

"A String",

1558

],

1559

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1560

"A String",

1561

],

1562

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1563

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1564

"A String",

1565

],

1566

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1567

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1568

"A String",

1569

],

1570

"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.

1571

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1572

"A String",

1573

],

1574

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1575

},

1576

"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.

1577

# 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^]

1578

# 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]

1579

"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.

1580

"httpStatus": 42, # The HTTP status code used to abort the request.

1581

# The value must be between 200 and 599 inclusive.

1582

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1583

# The value must be between 0.0 and 100.0 inclusive.

1584

},

1585

"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.

1586

"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.

1587

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1588

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1589

},

1590

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1591

# The value must be between 0.0 and 100.0 inclusive.

1592

},

1593

},

1594

"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^]

1595

# 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]

1596

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1597

},

1598

"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^]

1599

# 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]

1600

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1601

"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.

1602

# 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.

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

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1607

# - 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.

1608

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1609

# -

1610

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1611

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1612

# - 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.

1613

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1614

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1615

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1616

# - 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.

1621

# 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^]

1622

# 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]

1623

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1624

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1625

},

1626

"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]

1627

# 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^]

1628

# 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]

1629

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1630

# The value must be between 1 and 255 characters.

1631

"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.

1632

# The value must be between 1 and 1024 characters.

1633

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1634

"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.

1635

# 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]

1636

{ # 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

1637

"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.

1638

"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.

1639

# 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^]

1640

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1641

# 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]

1642

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1643

{ # Specification determining how headers are added to requests or responses.

1644

"headerName": "A String", # The name of the header.

1645

"headerValue": "A String", # The value of the header to add.

1646

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1647

# The default value is false.

1648

},

1649

],

1650

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1651

"A String",

1652

],

1653

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1654

{ # Specification determining how headers are added to requests or responses.

1655

"headerName": "A String", # The name of the header.

1656

"headerValue": "A String", # The value of the header to add.

1657

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1658

# The default value is false.

1659

},

1660

],

1661

"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) .

1666

# 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.

1667

# 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.

1672

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1673

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

1674

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1675

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1676

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1677

# The value must be between 1 and 255 characters.

1678

"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.

1679

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1680

# The default is set to false.

1681

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1682

# 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.

1683

# The value must be between 1 and 1024 characters.

1684

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1685

# 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.

1686

# The value must be between 1 and 1024 characters.

1687

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1688

# Supported values are:

1689

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1690

# - FOUND, which corresponds to 302.

1691

# - SEE_OTHER which corresponds to 303.

1692

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1693

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1694

"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.

1695

# 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.

1700

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

1701

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

1702

"description": "A String", # The short description conveying the intent of this routeRule.

1703

# The description can have a maximum length of 1024 characters.

1704

"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.

1705

# 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^]

1706

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1707

# 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]

1708

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1709

{ # Specification determining how headers are added to requests or responses.

1710

"headerName": "A String", # The name of the header.

1711

"headerValue": "A String", # The value of the header to add.

1712

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1713

# The default value is false.

1714

},

1715

],

1716

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1717

"A String",

1718

],

1719

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1720

{ # Specification determining how headers are added to requests or responses.

1721

"headerName": "A String", # The name of the header.

1722

"headerValue": "A String", # The value of the header to add.

1723

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1724

# The default value is false.

1725

},

1726

],

1727

"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.

1728

"A String",

1729

],

1730

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1731

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

1732

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1733

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

1734

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

1735

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

1736

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

1737

},

1738

],

1739

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

1740

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

1741

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1742

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

1743

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

1744

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

1745

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

1746

},

1747

],

1748

"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]

1749

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

1750

"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.

1751

# fullPathMatch must be between 1 and 1024 characters.

1752

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1753

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

1754

{ # matchRule criteria for request header matches.

1755

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

1756

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1757

"headerName": "A String", # The name of the HTTP header to match.

1758

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

1759

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1760

# 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]

1761

"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.

1762

# The default setting is false.

1763

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

1764

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1765

"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.

1766

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1767

"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.

1768

# For example for a range [-5, 0]

1769

# - -3 will match.

1770

# - 0 will not match.

1771

# - 0.25 will not match.

1772

# - -3someString will not match.

1773

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1774

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1775

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

1776

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

1777

},

1778

"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

1779

# 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.

1780

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1781

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1782

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

1783

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1784

},

1785

],

1786

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

1787

# The default value is false.

1788

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1789

# Not supported when the URL map is bound to target gRPC proxy.

1790

"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.

1791

# 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]

1792

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

1793

# 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^]

1794

# 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]

1795

{ # 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.

1796

# 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.

1797

# 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.

1798

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

1799

# This list must not be empty and can have at the most 64 entries.

1800

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

1801

"name": "A String", # Name of metadata label.

1802

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

1803

"value": "A String", # The value of the label must match the specified value.

1804

# value can have a maximum length of 1024 characters.

1805

},

1806

],

1807

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

1808

# Supported values are:

1809

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

1810

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

1811

},

1812

],

1813

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

1814

# The value must be between 1 and 1024 characters.

1815

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1816

"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^]

1817

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1818

{ # HttpRouteRuleMatch criteria for a request's query parameter.

1819

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

1820

# Only one of presentMatch, exactMatch or regexMatch must be set.

1821

"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.

1822

"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.

1823

# Only one of presentMatch, exactMatch or regexMatch must be set.

1824

"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

1825

# Only one of presentMatch, exactMatch or regexMatch must be set.

1826

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

1827

},

1828

],

1829

"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

1830

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1831

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1832

},

1833

],

1834

"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.

1835

# 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.

1836

# 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.

1837

"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.

1838

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1839

# 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]

1840

"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^]

1841

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1842

"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.

1843

# Default is false.

1844

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

1845

"A String",

1846

],

1847

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1848

"A String",

1849

],

1850

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

1851

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1852

"A String",

1853

],

1854

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

1855

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

1856

"A String",

1857

],

1858

"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.

1859

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1860

"A String",

1861

],

1862

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1863

},

1864

"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.

1865

# 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^]

1866

# 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]

1867

"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.

1868

"httpStatus": 42, # The HTTP status code used to abort the request.

1869

# The value must be between 200 and 599 inclusive.

1870

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

1871

# The value must be between 0.0 and 100.0 inclusive.

1872

},

1873

"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.

1874

"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.

1875

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1876

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1877

},

1878

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

1879

# The value must be between 0.0 and 100.0 inclusive.

1880

},

1881

},

1882

"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^]

1883

# 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]

1884

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1885

},

1886

"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^]

1887

# 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]

1888

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

1889

"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.

1890

# 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.

1891

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1892

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1893

},

1894

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

1895

# - 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.

1896

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

1897

# -

1898

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

1899

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

1900

# - 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.

1901

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

1902

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

1903

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

1904

# - 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.

1909

# 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^]

1910

# 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]

1911

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1912

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1913

},

1914

"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]

1915

# 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^]

1916

# 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]

1917

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

1918

# The value must be between 1 and 255 characters.

1919

"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.

1920

# The value must be between 1 and 1024 characters.

1921

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1922

"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.

1923

# 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]

1924

{ # 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

1925

"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.

1926

"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.

1927

# 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^]

1928

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

1929

# 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]

1930

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1931

{ # Specification determining how headers are added to requests or responses.

1932

"headerName": "A String", # The name of the header.

1933

"headerValue": "A String", # The value of the header to add.

1934

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1935

# The default value is false.

1936

},

1937

],

1938

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1939

"A String",

1940

],

1941

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1942

{ # Specification determining how headers are added to requests or responses.

1943

"headerName": "A String", # The name of the header.

1944

"headerValue": "A String", # The value of the header to add.

1945

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

1946

# The default value is false.

1947

},

1948

],

1949

"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) .

1954

# 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.

1955

# 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.

1960

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1961

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

1962

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1963

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1964

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

1965

# The value must be between 1 and 255 characters.

1966

"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.

1967

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

1968

# The default is set to false.

1969

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

1970

# 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.

1971

# The value must be between 1 and 1024 characters.

1972

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

1973

# 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.

1974

# The value must be between 1 and 1024 characters.

1975

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

1976

# Supported values are:

1977

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

1978

# - FOUND, which corresponds to 302.

1979

# - SEE_OTHER which corresponds to 303.

1980

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

1981

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1982

"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.

1983

# 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.

1990

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1991

"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^]

1992

# 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]

1993

{ # Message for the expected URL mappings.

1994

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1995

"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]

1996

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1997

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

1998

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1999

},

2000

],

2001

}</pre>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2005

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2006

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

2007

2008

Args:

2009

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2010

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2011

The object takes the form of:

2012

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2013

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2014

#

2015

# Google Compute Engine has two URL Map resources:

2016

#

2017

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

2018

#

2019

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

2020

#

2021

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

2022

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2023

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

2024

#

2025

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

2026

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2027

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

2028

#

2029

# 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.

2030

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

2031

"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.

2032

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2033

# 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^]

2034

# 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]

2035

"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^]

2036

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2037

"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.

2038

# Default is false.

2039

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2040

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2041

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2042

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2043

"A String",

2044

],

2045

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2046

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2047

"A String",

2048

],

2049

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2050

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2051

"A String",

2052

],

2053

"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.

2054

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2055

"A String",

2056

],

2057

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2058

},

2059

"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.

2060

# 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^]

2061

# 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]

2062

"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.

2063

"httpStatus": 42, # The HTTP status code used to abort the request.

2064

# The value must be between 200 and 599 inclusive.

2065

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2066

# The value must be between 0.0 and 100.0 inclusive.

2067

},

2068

"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.

2069

"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.

2070

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2071

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2072

},

2073

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2074

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2075

},

2076

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2077

"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^]

2078

# 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]

2079

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2080

},

2081

"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^]

2082

# 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]

2083

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2084

"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.

2085

# 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.

2086

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2087

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2088

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2089

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2090

# - 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.

2091

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2092

# -

2093

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2094

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2095

# - 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.

2096

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2097

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2098

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2099

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

2100

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2101

],

2102

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2103

"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.

2104

# 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^]

2105

# 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]

2106

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2107

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2108

},

2109

"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]

2110

# 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^]

2111

# 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]

2112

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2113

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2114

"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.

2115

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2116

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2117

"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.

2118

# 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]

2119

{ # 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

2120

"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.

2121

"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.

2122

# 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^]

2123

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2124

# 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]

2125

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2126

{ # Specification determining how headers are added to requests or responses.

2127

"headerName": "A String", # The name of the header.

2128

"headerValue": "A String", # The value of the header to add.

2129

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2130

# The default value is false.

2131

},

2132

],

2133

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2134

"A String",

2135

],

2136

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2137

{ # Specification determining how headers are added to requests or responses.

2138

"headerName": "A String", # The name of the header.

2139

"headerValue": "A String", # The value of the header to add.

2140

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2141

# The default value is false.

2142

},

2143

],

2144

"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) .

2149

# 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.

2150

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2151

},

2152

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2153

},

2154

"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.

2155

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2156

# 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]

2157

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

2158

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2159

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2160

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2161

# The value must be between 1 and 255 characters.

2162

"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.

2163

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2164

# The default is set to false.

2165

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2166

# 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.

2167

# The value must be between 1 and 1024 characters.

2168

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2169

# 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.

2170

# The value must be between 1 and 1024 characters.

2171

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2172

# Supported values are:

2173

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2174

# - FOUND, which corresponds to 302.

2175

# - SEE_OTHER which corresponds to 303.

2176

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2177

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2178

"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.

2179

# The default is set to false.

2180

},

2181

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2182

"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.

2183

#

2184

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2185

"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.

2186

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2187

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2188

# 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]

2189

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2190

{ # Specification determining how headers are added to requests or responses.

2191

"headerName": "A String", # The name of the header.

2192

"headerValue": "A String", # The value of the header to add.

2193

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2194

# The default value is false.

2195

},

2196

],

2197

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2198

"A String",

2199

],

2200

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2201

{ # Specification determining how headers are added to requests or responses.

2202

"headerName": "A String", # The name of the header.

2203

"headerValue": "A String", # The value of the header to add.

2204

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2205

# The default value is false.

2206

},

2207

],

2208

"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.

2213

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2214

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2215

"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^]

2216

# * 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]

2217

"A String",

2218

],

2219

"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.

2220

},

2221

],

2222

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2223

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2224

"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.

2225

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2226

{ # 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.

2227

"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.

2228

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2229

# UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2230

"corsPolicy": { # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing # The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2231

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2232

"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.

2233

# Default is false.

2234

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2235

"A String",

2236

],

2237

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2238

"A String",

2239

],

2240

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2241

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2242

"A String",

2243

],

2244

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2245

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2246

"A String",

2247

],

2248

"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.

2249

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2250

"A String",

2251

],

2252

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2253

},

2254

"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.

2255

# 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^]

2256

# 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]

2257

"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.

2258

"httpStatus": 42, # The HTTP status code used to abort the request.

2259

# The value must be between 200 and 599 inclusive.

2260

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2261

# The value must be between 0.0 and 100.0 inclusive.

2262

},

2263

"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.

2264

"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.

2265

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2266

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2267

},

2268

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2269

# The value must be between 0.0 and 100.0 inclusive.

2270

},

2271

},

2272

"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^]

2273

# 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]

2274

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2275

},

2276

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2277

# 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]

2278

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2279

"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.

2280

# 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.

2281

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2282

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2283

},

2284

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2285

# - 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.

2286

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2287

# -

2288

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2289

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2290

# - 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.

2291

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2292

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2293

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2294

# - 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.

2299

# 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^]

2300

# 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]

2301

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2302

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2303

},

2304

"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]

2305

# 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^]

2306

# 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]

2307

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2308

# The value must be between 1 and 255 characters.

2309

"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.

2310

# The value must be between 1 and 1024 characters.

2311

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2312

"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.

2313

# 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]

2314

{ # 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

2315

"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.

2316

"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.

2317

# 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^]

2318

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2319

# 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]

2320

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2321

{ # Specification determining how headers are added to requests or responses.

2322

"headerName": "A String", # The name of the header.

2323

"headerValue": "A String", # The value of the header to add.

2324

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2325

# The default value is false.

2326

},

2327

],

2328

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2329

"A String",

2330

],

2331

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2332

{ # Specification determining how headers are added to requests or responses.

2333

"headerName": "A String", # The name of the header.

2334

"headerValue": "A String", # The value of the header to add.

2335

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2336

# The default value is false.

2337

},

2338

],

2339

"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) .

2344

# 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.

2345

# 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:

2350

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

2351

# - compute/v1/projects/project/global/backendServices/backendService

2352

# - 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.

2353

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

2354

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

2355

# - compute.backendBuckets.use

2356

# - compute.backendServices.use

2357

"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.

2358

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2359

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2360

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2361

# The value must be between 1 and 255 characters.

2362

"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.

2363

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2364

# The default is set to false.

2365

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2366

# 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.

2367

# The value must be between 1 and 1024 characters.

2368

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2369

# 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.

2370

# The value must be between 1 and 1024 characters.

2371

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2372

# Supported values are:

2373

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2374

# - FOUND, which corresponds to 302.

2375

# - SEE_OTHER which corresponds to 303.

2376

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2377

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2378

"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.

2379

# The default is set to false.

2380

},

2381

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

2382

"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.

2383

# 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^]

2384

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2385

# 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]

2386

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2387

{ # Specification determining how headers are added to requests or responses.

2388

"headerName": "A String", # The name of the header.

2389

"headerValue": "A String", # The value of the header to add.

2390

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2391

# The default value is false.

2392

},

2393

],

2394

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2395

"A String",

2396

],

2397

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2398

{ # Specification determining how headers are added to requests or responses.

2399

"headerName": "A String", # The name of the header.

2400

"headerValue": "A String", # The value of the header to add.

2401

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2402

# The default value is false.

2403

},

2404

],

2405

"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.

2410

"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.

2411

# 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.

2412

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

2413

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2414

"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.

2415

"A String",

2416

],

2417

"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.

2418

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2419

# 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]

2420

"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^]

2421

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2422

"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.

2423

# Default is false.

2424

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2425

"A String",

2426

],

2427

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2428

"A String",

2429

],

2430

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2431

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2432

"A String",

2433

],

2434

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2435

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2436

"A String",

2437

],

2438

"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.

2439

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2440

"A String",

2441

],

2442

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2443

},

2444

"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.

2445

# 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^]

2446

# 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]

2447

"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.

2448

"httpStatus": 42, # The HTTP status code used to abort the request.

2449

# The value must be between 200 and 599 inclusive.

2450

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2451

# The value must be between 0.0 and 100.0 inclusive.

2452

},

2453

"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.

2454

"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.

2455

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2456

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2457

},

2458

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2459

# The value must be between 0.0 and 100.0 inclusive.

2460

},

2461

},

2462

"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^]

2463

# 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]

2464

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2465

},

2466

"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^]

2467

# 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]

2468

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2469

"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.

2470

# 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.

2471

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2472

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2473

},

2474

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2475

# - 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.

2476

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2477

# -

2478

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2479

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2480

# - 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.

2481

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2482

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2483

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2484

# - 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.

2489

# 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^]

2490

# 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]

2491

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2492

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2493

},

2494

"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]

2495

# 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^]

2496

# 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]

2497

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2498

# The value must be between 1 and 255 characters.

2499

"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.

2500

# The value must be between 1 and 1024 characters.

2501

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2502

"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.

2503

# 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]

2504

{ # 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

2505

"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.

2506

"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.

2507

# 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^]

2508

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2509

# 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]

2510

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2511

{ # Specification determining how headers are added to requests or responses.

2512

"headerName": "A String", # The name of the header.

2513

"headerValue": "A String", # The value of the header to add.

2514

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2515

# The default value is false.

2516

},

2517

],

2518

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2519

"A String",

2520

],

2521

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2522

{ # Specification determining how headers are added to requests or responses.

2523

"headerName": "A String", # The name of the header.

2524

"headerValue": "A String", # The value of the header to add.

2525

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2526

# The default value is false.

2527

},

2528

],

2529

"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) .

2534

# 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.

2535

# 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.

2540

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2541

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

2542

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2543

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2544

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2545

# The value must be between 1 and 255 characters.

2546

"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.

2547

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2548

# The default is set to false.

2549

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2550

# 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.

2551

# The value must be between 1 and 1024 characters.

2552

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2553

# 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.

2554

# The value must be between 1 and 1024 characters.

2555

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2556

# Supported values are:

2557

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2558

# - FOUND, which corresponds to 302.

2559

# - SEE_OTHER which corresponds to 303.

2560

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2561

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2562

"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.

2563

# 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.

2568

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

2569

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

2570

"description": "A String", # The short description conveying the intent of this routeRule.

2571

# The description can have a maximum length of 1024 characters.

2572

"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.

2573

# 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^]

2574

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2575

# 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]

2576

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2577

{ # Specification determining how headers are added to requests or responses.

2578

"headerName": "A String", # The name of the header.

2579

"headerValue": "A String", # The value of the header to add.

2580

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2581

# The default value is false.

2582

},

2583

],

2584

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2585

"A String",

2586

],

2587

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2588

{ # Specification determining how headers are added to requests or responses.

2589

"headerName": "A String", # The name of the header.

2590

"headerValue": "A String", # The value of the header to add.

2591

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2592

# The default value is false.

2593

},

2594

],

2595

"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.

2596

"A String",

2597

],

2598

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2599

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

2600

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2601

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

2602

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

2603

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

2604

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

2605

},

2606

],

2607

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

2608

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

2609

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2610

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

2611

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

2612

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

2613

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

2614

},

2615

],

2616

"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]

2617

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

2618

"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.

2619

# fullPathMatch must be between 1 and 1024 characters.

2620

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2621

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2622

{ # matchRule criteria for request header matches.

2623

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

2624

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2625

"headerName": "A String", # The name of the HTTP header to match.

2626

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

2627

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2628

# 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]

2629

"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.

2630

# The default setting is false.

2631

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

2632

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2633

"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.

2634

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2635

"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.

2636

# For example for a range [-5, 0]

2637

# - -3 will match.

2638

# - 0 will not match.

2639

# - 0.25 will not match.

2640

# - -3someString will not match.

2641

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2642

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2643

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2644

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2645

},

2646

"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

2647

# 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.

2648

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2649

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2650

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

2651

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2652

},

2653

],

2654

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

2655

# The default value is false.

2656

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2657

# Not supported when the URL map is bound to target gRPC proxy.

2658

"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.

2659

# 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]

2660

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

2661

# 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^]

2662

# 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]

2663

{ # 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.

2664

# 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.

2665

# 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.

2666

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

2667

# This list must not be empty and can have at the most 64 entries.

2668

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

2669

"name": "A String", # Name of metadata label.

2670

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

2671

"value": "A String", # The value of the label must match the specified value.

2672

# value can have a maximum length of 1024 characters.

2673

},

2674

],

2675

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

2676

# Supported values are:

2677

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

2678

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

2679

},

2680

],

2681

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

2682

# The value must be between 1 and 1024 characters.

2683

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2684

"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^]

2685

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2686

{ # HttpRouteRuleMatch criteria for a request's query parameter.

2687

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

2688

# Only one of presentMatch, exactMatch or regexMatch must be set.

2689

"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.

2690

"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.

2691

# Only one of presentMatch, exactMatch or regexMatch must be set.

2692

"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

2693

# Only one of presentMatch, exactMatch or regexMatch must be set.

2694

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

2695

},

2696

],

2697

"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

2698

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2699

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2700

},

2701

],

2702

"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.

2703

# 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.

2704

# 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.

2705

"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.

2706

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2707

# 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]

2708

"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^]

2709

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2710

"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.

2711

# Default is false.

2712

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2713

"A String",

2714

],

2715

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2716

"A String",

2717

],

2718

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

2719

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2720

"A String",

2721

],

2722

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

2723

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

2724

"A String",

2725

],

2726

"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.

2727

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2728

"A String",

2729

],

2730

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2731

},

2732

"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.

2733

# 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^]

2734

# 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]

2735

"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.

2736

"httpStatus": 42, # The HTTP status code used to abort the request.

2737

# The value must be between 200 and 599 inclusive.

2738

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

2739

# The value must be between 0.0 and 100.0 inclusive.

2740

},

2741

"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.

2742

"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.

2743

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2744

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2745

},

2746

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

2747

# The value must be between 0.0 and 100.0 inclusive.

2748

},

2749

},

2750

"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^]

2751

# 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]

2752

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2753

},

2754

"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^]

2755

# 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]

2756

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

2757

"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.

2758

# 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.

2759

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2760

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2761

},

2762

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

2763

# - 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.

2764

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

2765

# -

2766

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

2767

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

2768

# - 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.

2769

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

2770

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

2771

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

2772

# - 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.

2777

# 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^]

2778

# 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]

2779

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2780

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2781

},

2782

"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]

2783

# 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^]

2784

# 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]

2785

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

2786

# The value must be between 1 and 255 characters.

2787

"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.

2788

# The value must be between 1 and 1024 characters.

2789

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2790

"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.

2791

# 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]

2792

{ # 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

2793

"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.

2794

"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.

2795

# 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^]

2796

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

2797

# 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]

2798

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2799

{ # Specification determining how headers are added to requests or responses.

2800

"headerName": "A String", # The name of the header.

2801

"headerValue": "A String", # The value of the header to add.

2802

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2803

# The default value is false.

2804

},

2805

],

2806

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2807

"A String",

2808

],

2809

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2810

{ # Specification determining how headers are added to requests or responses.

2811

"headerName": "A String", # The name of the header.

2812

"headerValue": "A String", # The value of the header to add.

2813

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

2814

# The default value is false.

2815

},

2816

],

2817

"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) .

2822

# 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.

2823

# 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.

2828

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2829

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

2830

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2831

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2832

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

2833

# The value must be between 1 and 255 characters.

2834

"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.

2835

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

2836

# The default is set to false.

2837

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

2838

# 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.

2839

# The value must be between 1 and 1024 characters.

2840

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

2841

# 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.

2842

# The value must be between 1 and 1024 characters.

2843

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

2844

# Supported values are:

2845

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

2846

# - FOUND, which corresponds to 302.

2847

# - SEE_OTHER which corresponds to 303.

2848

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

2849

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2850

"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.

2851

# 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.

2858

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2859

"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^]

2860

# 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]

2861

{ # Message for the expected URL mappings.

2862

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2863

"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]

2864

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2865

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

2866

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2867

},

2868

],

2869

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2870

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2871

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.

2872

2873

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.

2874

2875

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2876

2877

Returns:

2878

An object of the form:

2879

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2880

{ # Represents an Operation resource.

2881

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2882

# Google Compute Engine has three Operation resources:

2883

#

2884

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2885

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2886

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2887

#

2888

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2889

# - For global operations, use the `globalOperations` resource.

2890

# - For regional operations, use the `regionOperations` resource.

2891

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2892

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2893

# 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]

2894

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2895

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2896

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2897

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2898

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2899

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2900

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2901

"code": "A String", # [Output Only] The error type identifier for this error.

2902

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2903

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2904

},

2905

],

2906

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2907

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2908

"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.

2909

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2910

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2911

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2912

"name": "A String", # [Output Only] Name of the operation.

2913

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2914

"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.

2915

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2916

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2917

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2918

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2919

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2920

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2921

"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.

2922

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2923

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2924

{

2925

"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.

2926

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

2927

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

2928

{

2929

"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).

2930

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2931

},

2932

],

2933

"message": "A String", # [Output Only] A human-readable description of the warning code.

2934

},

2935

],

2936

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2941

<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2942

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

2943

2944

Args:

2945

project: string, Project ID for this request. (required)

2946

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2947

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2948

The object takes the form of:

2949

2950

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2951

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

2952

"path": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2953

}

2954

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2955

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.

2956

2957

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.

2958

2959

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2960

2961

Returns:

2962

An object of the form:

2963

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2964

{ # Represents an Operation resource.

2965

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2966

# Google Compute Engine has three Operation resources:

2967

#

2968

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

2969

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2970

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

2971

#

2972

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2973

# - For global operations, use the `globalOperations` resource.

2974

# - For regional operations, use the `regionOperations` resource.

2975

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2976

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2977

# 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]

2978

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2979

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2980

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2981

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2982

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2983

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2984

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2985

"code": "A String", # [Output Only] The error type identifier for this error.

2986

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2987

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2988

},

2989

],

2990

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2991

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2992

"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.

2993

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2994

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2995

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2996

"name": "A String", # [Output Only] Name of the operation.

2997

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2998

"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.

2999

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3000

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3001

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3002

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3003

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3004

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3005

"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.

3006

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3007

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3008

{

3009

"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.

3010

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3011

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

3012

{

3013

"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).

3014

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3015

},

3016

],

3017

"message": "A String", # [Output Only] A human-readable description of the warning code.

3018

},

3019

],

3020

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3025

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3026

<pre>Retrieves the list of UrlMap resources available to the specified project.

3027

3028

Args:

3029

project: string, Project ID for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3030

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3031

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3032

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3033

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3034

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3035

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3036

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) ```

3037

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`)

3038

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

3039

3040

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.

3041

3042

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

3043

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^]

3044

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3045

3046

Returns:

3047

An object of the form:

3048

3049

{ # Contains a list of UrlMap resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3050

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

3051

"items": [ # A list of UrlMap resources.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3052

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3053

#

3054

# Google Compute Engine has two URL Map resources:

3055

#

3056

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3057

#

3058

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3059

#

3060

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3061

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3062

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

3063

#

3064

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

3065

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3066

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3067

#

3068

# 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.

3069

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3070

"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.

3071

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3072

# 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^]

3073

# 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]

3074

"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^]

3075

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3076

"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.

3077

# Default is false.

3078

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3079

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3080

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3081

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3082

"A String",

3083

],

3084

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3085

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3086

"A String",

3087

],

3088

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3089

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3090

"A String",

3091

],

3092

"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.

3093

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3094

"A String",

3095

],

3096

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3097

},

3098

"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.

3099

# 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^]

3100

# 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]

3101

"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.

3102

"httpStatus": 42, # The HTTP status code used to abort the request.

3103

# The value must be between 200 and 599 inclusive.

3104

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3105

# The value must be between 0.0 and 100.0 inclusive.

3106

},

3107

"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.

3108

"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.

3109

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3110

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3111

},

3112

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3113

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3114

},

3115

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3116

"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^]

3117

# 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]

3118

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3119

},

3120

"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^]

3121

# 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]

3122

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3123

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt.

3124

# If not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route.

3125

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3126

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3127

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3128

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3129

# - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams.

3130

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3131

# -

3132

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3133

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3134

# - refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry.

3135

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3136

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3137

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3138

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

3139

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3140

],

3141

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3142

"timeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.

3143

# If not specified, will use the largest timeout among all backend services associated with the route.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3144

# 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]

3145

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3146

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3147

},

3148

"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]

3149

# 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^]

3150

# 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]

3151

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3152

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3153

"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.

3154

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3155

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3156

"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.

3157

# 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]

3158

{ # 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

3159

"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.

3160

"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.

3161

# 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^]

3162

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3163

# 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]

3164

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3165

{ # Specification determining how headers are added to requests or responses.

3166

"headerName": "A String", # The name of the header.

3167

"headerValue": "A String", # The value of the header to add.

3168

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3169

# The default value is false.

3170

},

3171

],

3172

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3173

"A String",

3174

],

3175

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3176

{ # Specification determining how headers are added to requests or responses.

3177

"headerName": "A String", # The name of the header.

3178

"headerValue": "A String", # The value of the header to add.

3179

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3180

# The default value is false.

3181

},

3182

],

3183

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

3188

# 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.

3189

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3190

},

3191

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3192

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3193

"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.

3194

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3195

# 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]

3196

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

3197

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3198

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3199

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3200

# The value must be between 1 and 255 characters.

3201

"httpsRedirect": True or False, # If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.

3202

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3203

# The default is set to false.

3204

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3205

# pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3206

# The value must be between 1 and 1024 characters.

3207

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3208

# prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.

3209

# The value must be between 1 and 1024 characters.

3210

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3211

# Supported values are:

3212

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3213

# - FOUND, which corresponds to 302.

3214

# - SEE_OTHER which corresponds to 303.

3215

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3216

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3217

"stripQuery": True or False, # If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.

3218

# The default is set to false.

3219

},

3220

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3221

"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.

3222

#

3223

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3224

"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.

3225

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3226

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3227

# 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]

3228

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3229

{ # Specification determining how headers are added to requests or responses.

3230

"headerName": "A String", # The name of the header.

3231

"headerValue": "A String", # The value of the header to add.

3232

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3233

# The default value is false.

3234

},

3235

],

3236

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3237

"A String",

3238

],

3239

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3240

{ # Specification determining how headers are added to requests or responses.

3241

"headerName": "A String", # The name of the header.

3242

"headerValue": "A String", # The value of the header to add.

3243

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3244

# The default value is false.

3245

},

3246

],

3247

"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.

3252

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3253

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3254

"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^]

3255

# * 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]

3256

"A String",

3257

],

3258

"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.

3259

},

3260

],

3261

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3262

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3263

"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.

3264

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3265

{ # 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.

3266

"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.

3267

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3268

# 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]

3269

"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^]

3270

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3271

"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.

3272

# Default is false.

3273

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3274

"A String",

3275

],

3276

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3277

"A String",

3278

],

3279

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3280

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3281

"A String",

3282

],

3283

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3284

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3285

"A String",

3286

],

3287

"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.

3288

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3289

"A String",

3290

],

3291

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3292

},

3293

"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.

3294

# 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^]

3295

# 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]

3296

"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.

3297

"httpStatus": 42, # The HTTP status code used to abort the request.

3298

# The value must be between 200 and 599 inclusive.

3299

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3300

# The value must be between 0.0 and 100.0 inclusive.

3301

},

3302

"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.

3303

"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.

3304

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3305

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3306

},

3307

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3308

# The value must be between 0.0 and 100.0 inclusive.

3309

},

3310

},

3311

"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^]

3312

# 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]

3313

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3314

},

3315

"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^]

3316

# 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]

3317

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3318

"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.

3319

# 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.

3320

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3321

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3322

},

3323

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3324

# - 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.

3325

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3326

# -

3327

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3328

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3329

# - 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.

3330

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3331

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3332

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3333

# - 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.

3338

# 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^]

3339

# 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]

3340

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3341

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3342

},

3343

"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]

3344

# 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^]

3345

# 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]

3346

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3347

# The value must be between 1 and 255 characters.

3348

"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.

3349

# The value must be between 1 and 1024 characters.

3350

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3351

"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.

3352

# 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]

3353

{ # 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

3354

"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.

3355

"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.

3356

# 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^]

3357

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3358

# 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]

3359

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3360

{ # Specification determining how headers are added to requests or responses.

3361

"headerName": "A String", # The name of the header.

3362

"headerValue": "A String", # The value of the header to add.

3363

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3364

# The default value is false.

3365

},

3366

],

3367

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3368

"A String",

3369

],

3370

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3371

{ # Specification determining how headers are added to requests or responses.

3372

"headerName": "A String", # The name of the header.

3373

"headerValue": "A String", # The value of the header to add.

3374

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3375

# The default value is false.

3376

},

3377

],

3378

"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) .

3383

# 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.

3384

# 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:

3389

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

3390

# - compute/v1/projects/project/global/backendServices/backendService

3391

# - 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.

3392

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

3393

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

3394

# - compute.backendBuckets.use

3395

# - compute.backendServices.use

3396

"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.

3397

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3398

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3399

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3400

# The value must be between 1 and 255 characters.

3401

"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.

3402

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3403

# The default is set to false.

3404

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3405

# 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.

3406

# The value must be between 1 and 1024 characters.

3407

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3408

# 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.

3409

# The value must be between 1 and 1024 characters.

3410

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3411

# Supported values are:

3412

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3413

# - FOUND, which corresponds to 302.

3414

# - SEE_OTHER which corresponds to 303.

3415

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3416

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3417

"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.

3418

# The default is set to false.

3419

},

3420

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

3421

"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.

3422

# 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^]

3423

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3424

# 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]

3425

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3426

{ # Specification determining how headers are added to requests or responses.

3427

"headerName": "A String", # The name of the header.

3428

"headerValue": "A String", # The value of the header to add.

3429

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3430

# The default value is false.

3431

},

3432

],

3433

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3434

"A String",

3435

],

3436

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3437

{ # Specification determining how headers are added to requests or responses.

3438

"headerName": "A String", # The name of the header.

3439

"headerValue": "A String", # The value of the header to add.

3440

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3441

# The default value is false.

3442

},

3443

],

3444

"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.

3449

"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.

3450

# 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.

3451

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

3452

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3453

"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.

3454

"A String",

3455

],

3456

"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.

3457

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3458

# 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]

3459

"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^]

3460

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3461

"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.

3462

# Default is false.

3463

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3464

"A String",

3465

],

3466

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3467

"A String",

3468

],

3469

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3470

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3471

"A String",

3472

],

3473

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3474

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3475

"A String",

3476

],

3477

"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.

3478

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3479

"A String",

3480

],

3481

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3482

},

3483

"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.

3484

# 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^]

3485

# 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]

3486

"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.

3487

"httpStatus": 42, # The HTTP status code used to abort the request.

3488

# The value must be between 200 and 599 inclusive.

3489

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3490

# The value must be between 0.0 and 100.0 inclusive.

3491

},

3492

"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.

3493

"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.

3494

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3495

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3496

},

3497

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3498

# The value must be between 0.0 and 100.0 inclusive.

3499

},

3500

},

3501

"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^]

3502

# 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]

3503

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3504

},

3505

"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^]

3506

# 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]

3507

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3508

"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.

3509

# 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.

3510

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3511

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3512

},

3513

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3514

# - 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.

3515

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3516

# -

3517

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3518

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3519

# - 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.

3520

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3521

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3522

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3523

# - 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.

3528

# 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^]

3529

# 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]

3530

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3531

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3532

},

3533

"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]

3534

# 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^]

3535

# 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]

3536

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3537

# The value must be between 1 and 255 characters.

3538

"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.

3539

# The value must be between 1 and 1024 characters.

3540

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3541

"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.

3542

# 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]

3543

{ # 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

3544

"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.

3545

"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.

3546

# 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^]

3547

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3548

# 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]

3549

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3550

{ # Specification determining how headers are added to requests or responses.

3551

"headerName": "A String", # The name of the header.

3552

"headerValue": "A String", # The value of the header to add.

3553

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3554

# The default value is false.

3555

},

3556

],

3557

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3558

"A String",

3559

],

3560

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3561

{ # Specification determining how headers are added to requests or responses.

3562

"headerName": "A String", # The name of the header.

3563

"headerValue": "A String", # The value of the header to add.

3564

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3565

# The default value is false.

3566

},

3567

],

3568

"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) .

3573

# 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.

3574

# 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.

3579

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3580

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

3581

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3582

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3583

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3584

# The value must be between 1 and 255 characters.

3585

"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.

3586

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3587

# The default is set to false.

3588

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3589

# 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.

3590

# The value must be between 1 and 1024 characters.

3591

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3592

# 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.

3593

# The value must be between 1 and 1024 characters.

3594

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3595

# Supported values are:

3596

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3597

# - FOUND, which corresponds to 302.

3598

# - SEE_OTHER which corresponds to 303.

3599

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3600

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3601

"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.

3602

# 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.

3607

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

3608

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

3609

"description": "A String", # The short description conveying the intent of this routeRule.

3610

# The description can have a maximum length of 1024 characters.

3611

"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.

3612

# 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^]

3613

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3614

# 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]

3615

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3616

{ # Specification determining how headers are added to requests or responses.

3617

"headerName": "A String", # The name of the header.

3618

"headerValue": "A String", # The value of the header to add.

3619

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3620

# The default value is false.

3621

},

3622

],

3623

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3624

"A String",

3625

],

3626

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3627

{ # Specification determining how headers are added to requests or responses.

3628

"headerName": "A String", # The name of the header.

3629

"headerValue": "A String", # The value of the header to add.

3630

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3631

# The default value is false.

3632

},

3633

],

3634

"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.

3635

"A String",

3636

],

3637

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3638

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

3639

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3640

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

3641

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

3642

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

3643

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

3644

},

3645

],

3646

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

3647

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

3648

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3649

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

3650

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

3651

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

3652

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

3653

},

3654

],

3655

"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]

3656

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

3657

"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.

3658

# fullPathMatch must be between 1 and 1024 characters.

3659

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3660

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3661

{ # matchRule criteria for request header matches.

3662

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

3663

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3664

"headerName": "A String", # The name of the HTTP header to match.

3665

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

3666

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3667

# 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]

3668

"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.

3669

# The default setting is false.

3670

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

3671

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3672

"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.

3673

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3674

"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.

3675

# For example for a range [-5, 0]

3676

# - -3 will match.

3677

# - 0 will not match.

3678

# - 0.25 will not match.

3679

# - -3someString will not match.

3680

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3681

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3682

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3683

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3684

},

3685

"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

3686

# 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.

3687

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3688

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3689

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

3690

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3691

},

3692

],

3693

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

3694

# The default value is false.

3695

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3696

# Not supported when the URL map is bound to target gRPC proxy.

3697

"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.

3698

# 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]

3699

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

3700

# 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^]

3701

# 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]

3702

{ # 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.

3703

# 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.

3704

# 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.

3705

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

3706

# This list must not be empty and can have at the most 64 entries.

3707

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

3708

"name": "A String", # Name of metadata label.

3709

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

3710

"value": "A String", # The value of the label must match the specified value.

3711

# value can have a maximum length of 1024 characters.

3712

},

3713

],

3714

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

3715

# Supported values are:

3716

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

3717

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

3718

},

3719

],

3720

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

3721

# The value must be between 1 and 1024 characters.

3722

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3723

"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^]

3724

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3725

{ # HttpRouteRuleMatch criteria for a request's query parameter.

3726

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

3727

# Only one of presentMatch, exactMatch or regexMatch must be set.

3728

"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.

3729

"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.

3730

# Only one of presentMatch, exactMatch or regexMatch must be set.

3731

"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

3732

# Only one of presentMatch, exactMatch or regexMatch must be set.

3733

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

3734

},

3735

],

3736

"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

3737

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3738

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3739

},

3740

],

3741

"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.

3742

# 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.

3743

# 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.

3744

"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.

3745

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3746

# 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]

3747

"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^]

3748

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3749

"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.

3750

# Default is false.

3751

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3752

"A String",

3753

],

3754

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3755

"A String",

3756

],

3757

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3758

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3759

"A String",

3760

],

3761

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3762

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3763

"A String",

3764

],

3765

"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.

3766

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3767

"A String",

3768

],

3769

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3770

},

3771

"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.

3772

# 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^]

3773

# 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]

3774

"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.

3775

"httpStatus": 42, # The HTTP status code used to abort the request.

3776

# The value must be between 200 and 599 inclusive.

3777

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

3778

# The value must be between 0.0 and 100.0 inclusive.

3779

},

3780

"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.

3781

"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.

3782

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3783

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3784

},

3785

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

3786

# The value must be between 0.0 and 100.0 inclusive.

3787

},

3788

},

3789

"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^]

3790

# 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]

3791

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3792

},

3793

"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^]

3794

# 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]

3795

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

3796

"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.

3797

# 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.

3798

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3799

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3800

},

3801

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

3802

# - 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.

3803

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

3804

# -

3805

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

3806

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

3807

# - 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.

3808

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

3809

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

3810

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

3811

# - 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.

3816

# 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^]

3817

# 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]

3818

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3819

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3820

},

3821

"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]

3822

# 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^]

3823

# 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]

3824

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

3825

# The value must be between 1 and 255 characters.

3826

"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.

3827

# The value must be between 1 and 1024 characters.

3828

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3829

"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.

3830

# 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]

3831

{ # 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

3832

"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.

3833

"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.

3834

# 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^]

3835

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

3836

# 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]

3837

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3838

{ # Specification determining how headers are added to requests or responses.

3839

"headerName": "A String", # The name of the header.

3840

"headerValue": "A String", # The value of the header to add.

3841

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3842

# The default value is false.

3843

},

3844

],

3845

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3846

"A String",

3847

],

3848

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3849

{ # Specification determining how headers are added to requests or responses.

3850

"headerName": "A String", # The name of the header.

3851

"headerValue": "A String", # The value of the header to add.

3852

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

3853

# The default value is false.

3854

},

3855

],

3856

"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) .

3861

# 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.

3862

# 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.

3867

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3868

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

3869

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3870

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3871

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

3872

# The value must be between 1 and 255 characters.

3873

"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.

3874

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

3875

# The default is set to false.

3876

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

3877

# 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.

3878

# The value must be between 1 and 1024 characters.

3879

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

3880

# 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.

3881

# The value must be between 1 and 1024 characters.

3882

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

3883

# Supported values are:

3884

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

3885

# - FOUND, which corresponds to 302.

3886

# - SEE_OTHER which corresponds to 303.

3887

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

3888

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3889

"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.

3890

# 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.

3897

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3898

"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^]

3899

# 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]

3900

{ # Message for the expected URL mappings.

3901

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3902

"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]

3903

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3904

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

3905

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3906

},

3907

],

3908

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3909

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3910

"kind": "compute#urlMapList", # Type of resource.

3911

"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.

3912

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

3913

"warning": { # [Output Only] Informational warning message.

3914

"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.

3915

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

3916

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3917

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3918

"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).

3919

"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]

3920

},

3921

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3922

"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]

3923

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

3929

<pre>Retrieves the next page of results.

3930

3931

Args:

3932

previous_request: The request for the previous page. (required)

3933

previous_response: The response from the request for the previous page. (required)

3934

3935

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3936

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3937

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]

3942

<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]

3943

<pre>Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3944

3945

Args:

3946

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

3947

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3948

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

3949

The object takes the form of:

3950

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3951

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3952

#

3953

# Google Compute Engine has two URL Map resources:

3954

#

3955

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

3956

#

3957

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

3958

#

3959

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

3960

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

3961

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

3962

#

3963

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

3964

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3965

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

3966

#

3967

# 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.

3968

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

3969

"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.

3970

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3971

# 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^]

3972

# 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]

3973

"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^]

3974

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3975

"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.

3976

# Default is false.

3977

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3978

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3979

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3980

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3981

"A String",

3982

],

3983

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

3984

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3985

"A String",

3986

],

3987

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

3988

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

3989

"A String",

3990

],

3991

"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.

3992

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3993

"A String",

3994

],

3995

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3996

},

3997

"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.

3998

# 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^]

3999

# 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]

4000

"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.

4001

"httpStatus": 42, # The HTTP status code used to abort the request.

4002

# The value must be between 200 and 599 inclusive.

4003

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4004

# The value must be between 0.0 and 100.0 inclusive.

4005

},

4006

"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.

4007

"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.

4008

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4009

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4010

},

4011

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4012

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4013

},

4014

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4015

"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^]

4016

# 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]

4017

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4018

},

4019

"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^]

4020

# 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]

4021

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4022

"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.

4023

# 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.

4024

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4025

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4026

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4027

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4028

# - 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.

4029

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4030

# -

4031

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4032

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4033

# - 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.

4034

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4035

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4036

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4037

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

4038

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4039

],

4040

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4041

"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.

4042

# 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^]

4043

# 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]

4044

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4045

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4046

},

4047

"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]

4048

# 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^]

4049

# 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]

4050

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4051

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4052

"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.

4053

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4054

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4055

"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.

4056

# 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]

4057

{ # 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

4058

"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.

4059

"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.

4060

# 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^]

4061

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4062

# 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]

4063

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4064

{ # Specification determining how headers are added to requests or responses.

4065

"headerName": "A String", # The name of the header.

4066

"headerValue": "A String", # The value of the header to add.

4067

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4068

# The default value is false.

4069

},

4070

],

4071

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4072

"A String",

4073

],

4074

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4075

{ # Specification determining how headers are added to requests or responses.

4076

"headerName": "A String", # The name of the header.

4077

"headerValue": "A String", # The value of the header to add.

4078

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4079

# The default value is false.

4080

},

4081

],

4082

"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) .

4087

# 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.

4088

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4089

},

4090

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4091

},

4092

"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.

4093

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4094

# 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]

4095

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

4096

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4097

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4098

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4099

# The value must be between 1 and 255 characters.

4100

"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.

4101

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4102

# The default is set to false.

4103

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4104

# 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.

4105

# The value must be between 1 and 1024 characters.

4106

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4107

# 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.

4108

# The value must be between 1 and 1024 characters.

4109

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4110

# Supported values are:

4111

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4112

# - FOUND, which corresponds to 302.

4113

# - SEE_OTHER which corresponds to 303.

4114

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4115

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4116

"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.

4117

# The default is set to false.

4118

},

4119

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4120

"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.

4121

#

4122

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4123

"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.

4124

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4125

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4126

# 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]

4127

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4128

{ # Specification determining how headers are added to requests or responses.

4129

"headerName": "A String", # The name of the header.

4130

"headerValue": "A String", # The value of the header to add.

4131

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4132

# The default value is false.

4133

},

4134

],

4135

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4136

"A String",

4137

],

4138

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4139

{ # Specification determining how headers are added to requests or responses.

4140

"headerName": "A String", # The name of the header.

4141

"headerValue": "A String", # The value of the header to add.

4142

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4143

# The default value is false.

4144

},

4145

],

4146

"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.

4151

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4152

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4153

"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^]

4154

# * 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]

4155

"A String",

4156

],

4157

"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.

4158

},

4159

],

4160

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4161

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4162

"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.

4163

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4164

{ # 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.

4165

"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.

4166

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4167

# 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]

4168

"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^]

4169

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4170

"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.

4171

# Default is false.

4172

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4173

"A String",

4174

],

4175

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4176

"A String",

4177

],

4178

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4179

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4180

"A String",

4181

],

4182

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4183

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4184

"A String",

4185

],

4186

"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.

4187

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4188

"A String",

4189

],

4190

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4191

},

4192

"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.

4193

# 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^]

4194

# 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]

4195

"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.

4196

"httpStatus": 42, # The HTTP status code used to abort the request.

4197

# The value must be between 200 and 599 inclusive.

4198

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4199

# The value must be between 0.0 and 100.0 inclusive.

4200

},

4201

"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.

4202

"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.

4203

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4204

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4205

},

4206

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4207

# The value must be between 0.0 and 100.0 inclusive.

4208

},

4209

},

4210

"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^]

4211

# 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]

4212

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4213

},

4214

"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^]

4215

# 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]

4216

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4217

"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.

4218

# 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.

4219

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4220

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4221

},

4222

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4223

# - 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.

4224

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4225

# -

4226

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4227

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4228

# - 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.

4229

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4230

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4231

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4232

# - 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.

4237

# 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^]

4238

# 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]

4239

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4240

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4241

},

4242

"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]

4243

# 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^]

4244

# 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]

4245

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4246

# The value must be between 1 and 255 characters.

4247

"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.

4248

# The value must be between 1 and 1024 characters.

4249

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4250

"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.

4251

# 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]

4252

{ # 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

4253

"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.

4254

"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.

4255

# 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^]

4256

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4257

# 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]

4258

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4259

{ # Specification determining how headers are added to requests or responses.

4260

"headerName": "A String", # The name of the header.

4261

"headerValue": "A String", # The value of the header to add.

4262

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4263

# The default value is false.

4264

},

4265

],

4266

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4267

"A String",

4268

],

4269

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4270

{ # Specification determining how headers are added to requests or responses.

4271

"headerName": "A String", # The name of the header.

4272

"headerValue": "A String", # The value of the header to add.

4273

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4274

# The default value is false.

4275

},

4276

],

4277

"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) .

4282

# 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.

4283

# 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:

4288

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

4289

# - compute/v1/projects/project/global/backendServices/backendService

4290

# - 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.

4291

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

4292

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

4293

# - compute.backendBuckets.use

4294

# - compute.backendServices.use

4295

"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.

4296

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4297

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4298

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4299

# The value must be between 1 and 255 characters.

4300

"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.

4301

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4302

# The default is set to false.

4303

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4304

# 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.

4305

# The value must be between 1 and 1024 characters.

4306

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4307

# 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.

4308

# The value must be between 1 and 1024 characters.

4309

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4310

# Supported values are:

4311

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4312

# - FOUND, which corresponds to 302.

4313

# - SEE_OTHER which corresponds to 303.

4314

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4315

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4316

"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.

4317

# The default is set to false.

4318

},

4319

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

4320

"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.

4321

# 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^]

4322

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4323

# 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]

4324

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4325

{ # Specification determining how headers are added to requests or responses.

4326

"headerName": "A String", # The name of the header.

4327

"headerValue": "A String", # The value of the header to add.

4328

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4329

# The default value is false.

4330

},

4331

],

4332

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4333

"A String",

4334

],

4335

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4336

{ # Specification determining how headers are added to requests or responses.

4337

"headerName": "A String", # The name of the header.

4338

"headerValue": "A String", # The value of the header to add.

4339

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4340

# The default value is false.

4341

},

4342

],

4343

"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.

4348

"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.

4349

# 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.

4350

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

4351

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4352

"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.

4353

"A String",

4354

],

4355

"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.

4356

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4357

# 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]

4358

"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^]

4359

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4360

"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.

4361

# Default is false.

4362

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4363

"A String",

4364

],

4365

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4366

"A String",

4367

],

4368

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4369

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4370

"A String",

4371

],

4372

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4373

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4374

"A String",

4375

],

4376

"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.

4377

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4378

"A String",

4379

],

4380

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4381

},

4382

"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.

4383

# 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^]

4384

# 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]

4385

"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.

4386

"httpStatus": 42, # The HTTP status code used to abort the request.

4387

# The value must be between 200 and 599 inclusive.

4388

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4389

# The value must be between 0.0 and 100.0 inclusive.

4390

},

4391

"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.

4392

"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.

4393

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4394

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4395

},

4396

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4397

# The value must be between 0.0 and 100.0 inclusive.

4398

},

4399

},

4400

"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^]

4401

# 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]

4402

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4403

},

4404

"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^]

4405

# 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]

4406

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4407

"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.

4408

# 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.

4409

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4410

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4411

},

4412

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4413

# - 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.

4414

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4415

# -

4416

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4417

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4418

# - 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.

4419

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4420

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4421

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4422

# - 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.

4427

# 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^]

4428

# 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]

4429

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4430

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4431

},

4432

"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]

4433

# 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^]

4434

# 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]

4435

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4436

# The value must be between 1 and 255 characters.

4437

"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.

4438

# The value must be between 1 and 1024 characters.

4439

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4440

"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.

4441

# 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]

4442

{ # 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

4443

"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.

4444

"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.

4445

# 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^]

4446

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4447

# 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]

4448

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4449

{ # Specification determining how headers are added to requests or responses.

4450

"headerName": "A String", # The name of the header.

4451

"headerValue": "A String", # The value of the header to add.

4452

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4453

# The default value is false.

4454

},

4455

],

4456

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4457

"A String",

4458

],

4459

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4460

{ # Specification determining how headers are added to requests or responses.

4461

"headerName": "A String", # The name of the header.

4462

"headerValue": "A String", # The value of the header to add.

4463

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4464

# The default value is false.

4465

},

4466

],

4467

"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) .

4472

# 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.

4473

# 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.

4478

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4479

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

4480

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4481

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4482

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4483

# The value must be between 1 and 255 characters.

4484

"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.

4485

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4486

# The default is set to false.

4487

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4488

# 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.

4489

# The value must be between 1 and 1024 characters.

4490

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4491

# 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.

4492

# The value must be between 1 and 1024 characters.

4493

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4494

# Supported values are:

4495

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4496

# - FOUND, which corresponds to 302.

4497

# - SEE_OTHER which corresponds to 303.

4498

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4499

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4500

"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.

4501

# 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.

4506

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

4507

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

4508

"description": "A String", # The short description conveying the intent of this routeRule.

4509

# The description can have a maximum length of 1024 characters.

4510

"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.

4511

# 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^]

4512

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4513

# 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]

4514

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4515

{ # Specification determining how headers are added to requests or responses.

4516

"headerName": "A String", # The name of the header.

4517

"headerValue": "A String", # The value of the header to add.

4518

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4519

# The default value is false.

4520

},

4521

],

4522

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4523

"A String",

4524

],

4525

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4526

{ # Specification determining how headers are added to requests or responses.

4527

"headerName": "A String", # The name of the header.

4528

"headerValue": "A String", # The value of the header to add.

4529

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4530

# The default value is false.

4531

},

4532

],

4533

"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.

4534

"A String",

4535

],

4536

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4537

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

4538

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

4539

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

4540

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

4541

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

4542

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

4543

},

4544

],

4545

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

4546

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

4547

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

4548

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

4549

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

4550

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

4551

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

4552

},

4553

],

4554

"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]

4555

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

4556

"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.

4557

# fullPathMatch must be between 1 and 1024 characters.

4558

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4559

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4560

{ # matchRule criteria for request header matches.

4561

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

4562

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4563

"headerName": "A String", # The name of the HTTP header to match.

4564

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

4565

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4566

# 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]

4567

"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.

4568

# The default setting is false.

4569

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

4570

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4571

"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.

4572

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4573

"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.

4574

# For example for a range [-5, 0]

4575

# - -3 will match.

4576

# - 0 will not match.

4577

# - 0.25 will not match.

4578

# - -3someString will not match.

4579

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4580

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4581

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4582

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4583

},

4584

"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

4585

# 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.

4586

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4587

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4588

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

4589

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4590

},

4591

],

4592

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

4593

# The default value is false.

4594

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4595

# Not supported when the URL map is bound to target gRPC proxy.

4596

"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.

4597

# 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]

4598

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

4599

# 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^]

4600

# 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]

4601

{ # 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.

4602

# 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.

4603

# 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.

4604

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

4605

# This list must not be empty and can have at the most 64 entries.

4606

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

4607

"name": "A String", # Name of metadata label.

4608

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

4609

"value": "A String", # The value of the label must match the specified value.

4610

# value can have a maximum length of 1024 characters.

4611

},

4612

],

4613

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

4614

# Supported values are:

4615

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

4616

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

4617

},

4618

],

4619

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

4620

# The value must be between 1 and 1024 characters.

4621

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4622

"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^]

4623

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4624

{ # HttpRouteRuleMatch criteria for a request's query parameter.

4625

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

4626

# Only one of presentMatch, exactMatch or regexMatch must be set.

4627

"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.

4628

"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.

4629

# Only one of presentMatch, exactMatch or regexMatch must be set.

4630

"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

4631

# Only one of presentMatch, exactMatch or regexMatch must be set.

4632

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

4633

},

4634

],

4635

"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

4636

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4637

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4638

},

4639

],

4640

"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.

4641

# 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.

4642

# 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.

4643

"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.

4644

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4645

# 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]

4646

"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^]

4647

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4648

"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.

4649

# Default is false.

4650

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4651

"A String",

4652

],

4653

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4654

"A String",

4655

],

4656

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4657

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4658

"A String",

4659

],

4660

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4661

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4662

"A String",

4663

],

4664

"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.

4665

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4666

"A String",

4667

],

4668

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4669

},

4670

"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.

4671

# 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^]

4672

# 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]

4673

"abort": { # Specification for how requests are aborted as part of fault injection. # The specification for how client requests are aborted as part of fault injection.

4674

"httpStatus": 42, # The HTTP status code used to abort the request.

4675

# The value must be between 200 and 599 inclusive.

4676

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4677

# The value must be between 0.0 and 100.0 inclusive.

4678

},

4679

"delay": { # Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection. # The specification for how client requests are delayed as part of fault injection, before being sent to a backend service.

4680

"fixedDelay": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the value of the fixed delay interval.

4681

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4682

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4683

},

4684

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4685

# The value must be between 0.0 and 100.0 inclusive.

4686

},

4687

},

4688

"requestMirrorPolicy": { # A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. # Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4689

# 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]

4690

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4691

},

4692

"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^]

4693

# 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]

4694

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4695

"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.

4696

# 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.

4697

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4698

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4699

},

4700

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4701

# - 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.

4702

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4703

# -

4704

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4705

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4706

# - 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.

4707

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4708

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

4709

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

4710

# - 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.

4715

# 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^]

4716

# 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]

4717

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4718

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4719

},

4720

"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]

4721

# 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^]

4722

# 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]

4723

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

4724

# The value must be between 1 and 255 characters.

4725

"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.

4726

# The value must be between 1 and 1024 characters.

4727

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4728

"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.

4729

# 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]

4730

{ # 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

4731

"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.

4732

"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.

4733

# 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^]

4734

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

4735

# 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]

4736

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4737

{ # Specification determining how headers are added to requests or responses.

4738

"headerName": "A String", # The name of the header.

4739

"headerValue": "A String", # The value of the header to add.

4740

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4741

# The default value is false.

4742

},

4743

],

4744

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4745

"A String",

4746

],

4747

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4748

{ # Specification determining how headers are added to requests or responses.

4749

"headerName": "A String", # The name of the header.

4750

"headerValue": "A String", # The value of the header to add.

4751

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

4752

# The default value is false.

4753

},

4754

],

4755

"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) .

4760

# 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.

4761

# 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.

4766

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4767

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

4768

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4769

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4770

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

4771

# The value must be between 1 and 255 characters.

4772

"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.

4773

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

4774

# The default is set to false.

4775

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

4776

# 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.

4777

# The value must be between 1 and 1024 characters.

4778

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

4779

# 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.

4780

# The value must be between 1 and 1024 characters.

4781

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

4782

# Supported values are:

4783

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

4784

# - FOUND, which corresponds to 302.

4785

# - SEE_OTHER which corresponds to 303.

4786

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

4787

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4788

"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.

4789

# 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.

4796

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4797

"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^]

4798

# 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]

4799

{ # Message for the expected URL mappings.

4800

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4801

"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]

4802

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4803

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

4804

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4805

},

4806

],

4807

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4808

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4809

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.

4810

4811

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.

4812

4813

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4814

4815

Returns:

4816

An object of the form:

4817

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4818

{ # Represents an Operation resource.

4819

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4820

# Google Compute Engine has three Operation resources:

4821

#

4822

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

4823

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4824

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

4825

#

4826

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4827

# - For global operations, use the `globalOperations` resource.

4828

# - For regional operations, use the `regionOperations` resource.

4829

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4830

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4831

# 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]

4832

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

4833

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

4834

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

4835

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

4836

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

4837

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4838

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4839

"code": "A String", # [Output Only] The error type identifier for this error.

4840

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

4841

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4842

},

4843

],

4844

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4845

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

4846

"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.

4847

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

4848

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

4849

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

4850

"name": "A String", # [Output Only] Name of the operation.

4851

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

4852

"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.

4853

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

4854

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

4855

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

4856

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

4857

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

4858

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

4859

"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.

4860

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

4861

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

4862

{

4863

"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.

4864

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

4865

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

4866

{

4867

"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).

4868

"value": "A String", # [Output Only] A warning data value corresponding to the key.

4869

},

4870

],

4871

"message": "A String", # [Output Only] A human-readable description of the warning code.

4872

},

4873

],

4874

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4879

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4880

<pre>Returns permissions that a caller has on the specified resource.

4881

4882

Args:

4883

project: string, Project ID for this request. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4884

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4885

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4886

The object takes the form of:

4887

4888

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4889

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

4890

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}

Returns:

An object of the form:

4897

4898

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4899

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

4900

"A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

],

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4906

<code class="details" id="update">update(project, urlMap, body=None, requestId=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4907

<pre>Updates the specified UrlMap resource with the data included in the request.

4908

4909

Args:

4910

project: string, Project ID for this request. (required)

4911

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4912

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4913

The object takes the form of:

4914

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

4915

{ # Represents a URL Map resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4916

#

4917

# Google Compute Engine has two URL Map resources:

4918

#

4919

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

4920

#

4921

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

4922

#

4923

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

4924

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

4925

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

4926

#

4927

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

4928

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4929

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

4930

#

4931

# 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.

4932

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

4933

"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.

4934

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

4935

# 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^]

4936

# 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]

4937

"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^]

4938

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4939

"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.

4940

# Default is false.

4941

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4942

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4943

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4944

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4945

"A String",

4946

],

4947

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

4948

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4949

"A String",

4950

],

4951

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

4952

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

4953

"A String",

4954

],

4955

"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.

4956

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4957

"A String",

4958

],

4959

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4960

},

4961

"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.

4962

# 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^]

4963

# 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]

4964

"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.

4965

"httpStatus": 42, # The HTTP status code used to abort the request.

4966

# The value must be between 200 and 599 inclusive.

4967

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

4968

# The value must be between 0.0 and 100.0 inclusive.

4969

},

4970

"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.

4971

"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.

4972

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4973

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4974

},

4975

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

4976

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

4977

},

4978

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4979

"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^]

4980

# 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]

4981

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4982

},

4983

"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^]

4984

# 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]

4985

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

4986

"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.

4987

# 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.

4988

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4989

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

4990

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4991

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

4992

# - 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.

4993

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

4994

# -

4995

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

4996

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

4997

# - 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.

4998

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

4999

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5000

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5001

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5002

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5003

],

5004

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5005

"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.

5006

# 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^]

5007

# 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]

5008

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5009

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5010

},

5011

"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]

5012

# 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^]

5013

# 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]

5014

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5015

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5016

"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.

5017

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5018

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5019

"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.

5020

# 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]

5021

{ # 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

5022

"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.

5023

"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.

5024

# 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^]

5025

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5026

# 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]

5027

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5028

{ # Specification determining how headers are added to requests or responses.

5029

"headerName": "A String", # The name of the header.

5030

"headerValue": "A String", # The value of the header to add.

5031

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5032

# The default value is false.

5033

},

5034

],

5035

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5036

"A String",

5037

],

5038

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5039

{ # Specification determining how headers are added to requests or responses.

5040

"headerName": "A String", # The name of the header.

5041

"headerValue": "A String", # The value of the header to add.

5042

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5043

# The default value is false.

5044

},

5045

],

5046

"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) .

5051

# 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.

5052

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5053

},

5054

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5055

},

5056

"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.

5057

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5058

# 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]

5059

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5060

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5061

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5062

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5063

# The value must be between 1 and 255 characters.

5064

"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.

5065

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5066

# The default is set to false.

5067

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5068

# 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.

5069

# The value must be between 1 and 1024 characters.

5070

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5071

# 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.

5072

# The value must be between 1 and 1024 characters.

5073

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5074

# Supported values are:

5075

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5076

# - FOUND, which corresponds to 302.

5077

# - SEE_OTHER which corresponds to 303.

5078

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5079

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5080

"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.

5081

# The default is set to false.

5082

},

5083

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5084

"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.

5085

#

5086

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

5087

"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.

5088

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5089

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5090

# 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]

5091

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5092

{ # Specification determining how headers are added to requests or responses.

5093

"headerName": "A String", # The name of the header.

5094

"headerValue": "A String", # The value of the header to add.

5095

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5096

# The default value is false.

5097

},

5098

],

5099

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5100

"A String",

5101

],

5102

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5103

{ # Specification determining how headers are added to requests or responses.

5104

"headerName": "A String", # The name of the header.

5105

"headerValue": "A String", # The value of the header to add.

5106

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5107

# The default value is false.

5108

},

5109

],

5110

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"hostRules": [ # The list of HostRules to use against the URL.

5115

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

5116

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5117

"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^]

5118

# * 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]

5119

"A String",

5120

],

5121

"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.

5122

},

5123

],

5124

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

5125

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

5126

"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.

5127

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

5128

{ # 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.

5129

"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.

5130

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5131

# 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]

5132

"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^]

5133

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5134

"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.

5135

# Default is false.

5136

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5137

"A String",

5138

],

5139

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5140

"A String",

5141

],

5142

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5143

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5144

"A String",

5145

],

5146

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5147

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5148

"A String",

5149

],

5150

"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.

5151

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5152

"A String",

5153

],

5154

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5155

},

5156

"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.

5157

# 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^]

5158

# 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]

5159

"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.

5160

"httpStatus": 42, # The HTTP status code used to abort the request.

5161

# The value must be between 200 and 599 inclusive.

5162

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5163

# The value must be between 0.0 and 100.0 inclusive.

5164

},

5165

"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.

5166

"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.

5167

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5168

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5169

},

5170

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5171

# The value must be between 0.0 and 100.0 inclusive.

5172

},

5173

},

5174

"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^]

5175

# 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]

5176

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5177

},

5178

"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^]

5179

# 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]

5180

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5181

"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.

5182

# 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.

5183

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5184

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5185

},

5186

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5187

# - 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.

5188

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5189

# -

5190

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5191

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5192

# - 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.

5193

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5194

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5195

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5196

# - 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.

5201

# 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^]

5202

# 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]

5203

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5204

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5205

},

5206

"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]

5207

# 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^]

5208

# 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]

5209

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5210

# The value must be between 1 and 255 characters.

5211

"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.

5212

# The value must be between 1 and 1024 characters.

5213

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5214

"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.

5215

# 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]

5216

{ # 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

5217

"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.

5218

"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.

5219

# 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^]

5220

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5221

# 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]

5222

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5223

{ # Specification determining how headers are added to requests or responses.

5224

"headerName": "A String", # The name of the header.

5225

"headerValue": "A String", # The value of the header to add.

5226

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5227

# The default value is false.

5228

},

5229

],

5230

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5231

"A String",

5232

],

5233

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5234

{ # Specification determining how headers are added to requests or responses.

5235

"headerName": "A String", # The name of the header.

5236

"headerValue": "A String", # The value of the header to add.

5237

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5238

# The default value is false.

5239

},

5240

],

5241

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .

5246

# The selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.

5247

# The value must be between 0 and 1000

},

],

},

"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:

5252

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

5253

# - compute/v1/projects/project/global/backendServices/backendService

5254

# - 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.

5255

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

5256

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

5257

# - compute.backendBuckets.use

5258

# - compute.backendServices.use

5259

"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.

5260

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5261

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5262

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5263

# The value must be between 1 and 255 characters.

5264

"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.

5265

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5266

# The default is set to false.

5267

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5268

# 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.

5269

# The value must be between 1 and 1024 characters.

5270

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5271

# 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.

5272

# The value must be between 1 and 1024 characters.

5273

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5274

# Supported values are:

5275

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5276

# - FOUND, which corresponds to 302.

5277

# - SEE_OTHER which corresponds to 303.

5278

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5279

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5280

"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.

5281

# The default is set to false.

5282

},

5283

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

5284

"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.

5285

# 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^]

5286

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5287

# 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]

5288

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5289

{ # Specification determining how headers are added to requests or responses.

5290

"headerName": "A String", # The name of the header.

5291

"headerValue": "A String", # The value of the header to add.

5292

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5293

# The default value is false.

5294

},

5295

],

5296

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5297

"A String",

5298

],

5299

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

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

"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.

5312

"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.

5313

# 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.

5314

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

5315

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

5316

"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.

5317

"A String",

5318

],

5319

"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.

5320

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5321

# 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]

5322

"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^]

5323

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5324

"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.

5325

# Default is false.

5326

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5327

"A String",

5328

],

5329

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5330

"A String",

5331

],

5332

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5333

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5334

"A String",

5335

],

5336

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5337

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5338

"A String",

5339

],

5340

"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.

5341

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5342

"A String",

5343

],

5344

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5345

},

5346

"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.

5347

# 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^]

5348

# 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]

5349

"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.

5350

"httpStatus": 42, # The HTTP status code used to abort the request.

5351

# The value must be between 200 and 599 inclusive.

5352

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5353

# The value must be between 0.0 and 100.0 inclusive.

5354

},

5355

"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.

5356

"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.

5357

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5358

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5359

},

5360

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5361

# The value must be between 0.0 and 100.0 inclusive.

5362

},

5363

},

5364

"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^]

5365

# 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]

5366

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5367

},

5368

"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^]

5369

# 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]

5370

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5371

"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.

5372

# 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.

5373

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5374

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5375

},

5376

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5377

# - 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.

5378

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5379

# -

5380

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5381

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5382

# - 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.

5383

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5384

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5385

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5386

# - 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.

5391

# 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^]

5392

# 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]

5393

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5394

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5395

},

5396

"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]

5397

# 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^]

5398

# 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]

5399

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5400

# The value must be between 1 and 255 characters.

5401

"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.

5402

# The value must be between 1 and 1024 characters.

5403

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5404

"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.

5405

# 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]

5406

{ # 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

5407

"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.

5408

"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.

5409

# 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^]

5410

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5411

# 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]

5412

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5413

{ # Specification determining how headers are added to requests or responses.

5414

"headerName": "A String", # The name of the header.

5415

"headerValue": "A String", # The value of the header to add.

5416

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5417

# The default value is false.

5418

},

5419

],

5420

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5421

"A String",

5422

],

5423

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5424

{ # Specification determining how headers are added to requests or responses.

5425

"headerName": "A String", # The name of the header.

5426

"headerValue": "A String", # The value of the header to add.

5427

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5428

# The default value is false.

5429

},

5430

],

5431

"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) .

5436

# 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.

5437

# 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.

5442

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5443

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

5444

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5445

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5446

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5447

# The value must be between 1 and 255 characters.

5448

"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.

5449

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5450

# The default is set to false.

5451

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5452

# 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.

5453

# The value must be between 1 and 1024 characters.

5454

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5455

# 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.

5456

# The value must be between 1 and 1024 characters.

5457

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5458

# Supported values are:

5459

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5460

# - FOUND, which corresponds to 302.

5461

# - SEE_OTHER which corresponds to 303.

5462

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5463

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5464

"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.

5465

# 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.

5470

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

5471

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

5472

"description": "A String", # The short description conveying the intent of this routeRule.

5473

# The description can have a maximum length of 1024 characters.

5474

"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.

5475

# 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^]

5476

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5477

# 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]

5478

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5479

{ # Specification determining how headers are added to requests or responses.

5480

"headerName": "A String", # The name of the header.

5481

"headerValue": "A String", # The value of the header to add.

5482

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5483

# The default value is false.

5484

},

5485

],

5486

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5487

"A String",

5488

],

5489

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5490

{ # Specification determining how headers are added to requests or responses.

5491

"headerName": "A String", # The name of the header.

5492

"headerValue": "A String", # The value of the header to add.

5493

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5494

# The default value is false.

5495

},

5496

],

5497

"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.

5498

"A String",

5499

],

5500

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5501

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

5502

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

5503

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

5504

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

5505

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

5506

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

5507

},

5508

],

5509

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

5510

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

5511

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

5512

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

5513

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

5514

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

5515

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

5516

},

5517

],

5518

"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]

5519

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

5520

"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.

5521

# fullPathMatch must be between 1 and 1024 characters.

5522

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5523

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

5524

{ # matchRule criteria for request header matches.

5525

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

5526

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5527

"headerName": "A String", # The name of the HTTP header to match.

5528

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

5529

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5530

# 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]

5531

"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.

5532

# The default setting is false.

5533

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

5534

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5535

"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.

5536

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5537

"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.

5538

# For example for a range [-5, 0]

5539

# - -3 will match.

5540

# - 0 will not match.

5541

# - 0.25 will not match.

5542

# - -3someString will not match.

5543

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5544

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5545

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

5546

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

5547

},

5548

"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

5549

# 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.

5550

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5551

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5552

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

5553

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

5554

},

5555

],

5556

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

5557

# The default value is false.

5558

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5559

# Not supported when the URL map is bound to target gRPC proxy.

5560

"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.

5561

# 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]

5562

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

5563

# 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^]

5564

# 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]

5565

{ # 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.

5566

# 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.

5567

# 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.

5568

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

5569

# This list must not be empty and can have at the most 64 entries.

5570

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

5571

"name": "A String", # Name of metadata label.

5572

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

5573

"value": "A String", # The value of the label must match the specified value.

5574

# value can have a maximum length of 1024 characters.

5575

},

5576

],

5577

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

5578

# Supported values are:

5579

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

5580

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

5581

},

5582

],

5583

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

5584

# The value must be between 1 and 1024 characters.

5585

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5586

"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^]

5587

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5588

{ # HttpRouteRuleMatch criteria for a request's query parameter.

5589

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

5590

# Only one of presentMatch, exactMatch or regexMatch must be set.

5591

"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.

5592

"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.

5593

# Only one of presentMatch, exactMatch or regexMatch must be set.

5594

"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

5595

# Only one of presentMatch, exactMatch or regexMatch must be set.

5596

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

5597

},

5598

],

5599

"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

5600

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

5601

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

5602

},

5603

],

5604

"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.

5605

# 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.

5606

# 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.

5607

"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.

5608

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5609

# 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]

5610

"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^]

5611

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5612

"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.

5613

# Default is false.

5614

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5615

"A String",

5616

],

5617

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5618

"A String",

5619

],

5620

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5621

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5622

"A String",

5623

],

5624

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5625

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5626

"A String",

5627

],

5628

"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.

5629

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5630

"A String",

5631

],

5632

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5633

},

5634

"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.

5635

# 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^]

5636

# 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]

5637

"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.

5638

"httpStatus": 42, # The HTTP status code used to abort the request.

5639

# The value must be between 200 and 599 inclusive.

5640

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5641

# The value must be between 0.0 and 100.0 inclusive.

5642

},

5643

"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.

5644

"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.

5645

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5646

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5647

},

5648

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5649

# The value must be between 0.0 and 100.0 inclusive.

5650

},

5651

},

5652

"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^]

5653

# 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]

5654

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5655

},

5656

"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^]

5657

# 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]

5658

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5659

"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.

5660

# 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.

5661

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5662

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5663

},

5664

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5665

# - 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.

5666

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5667

# -

5668

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5669

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5670

# - 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.

5671

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5672

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5673

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5674

# - 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.

5679

# 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^]

5680

# 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]

5681

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5682

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5683

},

5684

"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]

5685

# 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^]

5686

# 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]

5687

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

5688

# The value must be between 1 and 255 characters.

5689

"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.

5690

# The value must be between 1 and 1024 characters.

5691

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5692

"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.

5693

# 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]

5694

{ # 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

5695

"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.

5696

"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.

5697

# 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^]

5698

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5699

# 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]

5700

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5701

{ # Specification determining how headers are added to requests or responses.

5702

"headerName": "A String", # The name of the header.

5703

"headerValue": "A String", # The value of the header to add.

5704

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5705

# The default value is false.

5706

},

5707

],

5708

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5709

"A String",

5710

],

5711

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5712

{ # Specification determining how headers are added to requests or responses.

5713

"headerName": "A String", # The name of the header.

5714

"headerValue": "A String", # The value of the header to add.

5715

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5716

# The default value is false.

5717

},

5718

],

5719

"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) .

5724

# 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.

5725

# 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.

5730

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

5731

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

5732

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5733

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5734

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

5735

# The value must be between 1 and 255 characters.

5736

"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.

5737

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

5738

# The default is set to false.

5739

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

5740

# 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.

5741

# The value must be between 1 and 1024 characters.

5742

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

5743

# 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.

5744

# The value must be between 1 and 1024 characters.

5745

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

5746

# Supported values are:

5747

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

5748

# - FOUND, which corresponds to 302.

5749

# - SEE_OTHER which corresponds to 303.

5750

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

5751

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

5752

"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.

5753

# 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.

5760

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5761

"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^]

5762

# 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]

5763

{ # Message for the expected URL mappings.

5764

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5765

"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]

5766

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5767

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

5768

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5769

},

5770

],

5771

}

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5772

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5773

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.

5774

5775

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.

5776

5777

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5778

5779

Returns:

5780

An object of the form:

5781

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5782

{ # Represents an Operation resource.

5783

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5784

# Google Compute Engine has three Operation resources:

5785

#

5786

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

5787

#

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5788

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

5789

#

5790

# Operations can be global, regional or zonal.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5791

# - For global operations, use the `globalOperations` resource.

5792

# - For regional operations, use the `regionOperations` resource.

5793

# - For zonal operations, use the `zonalOperations` resource.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5794

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5795

# 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]

5796

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

5797

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

5798

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

5799

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

5800

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

5801

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5802

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5803

"code": "A String", # [Output Only] The error type identifier for this error.

5804

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

5805

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5806

},

5807

],

5808

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5809

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

5810

"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.

5811

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

5812

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

5813

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

5814

"name": "A String", # [Output Only] Name of the operation.

5815

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

5816

"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.

5817

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

5818

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

5819

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

5820

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

5821

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

5822

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

5823

"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.

5824

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

5825

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

5826

{

5827

"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.

5828

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

5829

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

5830

{

5831

"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).

5832

"value": "A String", # [Output Only] A warning data value corresponding to the key.

5833

},

5834

],

5835

"message": "A String", # [Output Only] A human-readable description of the warning code.

5836

},

5837

],

5838

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5843

<code class="details" id="validate">validate(project, urlMap, body=None)</code>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5844

<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.

5845

5846

Args:

5847

project: string, Project ID for this request. (required)

5848

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

5849

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5850

The object takes the form of:

5851

5852

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5853

"resource": { # Represents a URL Map resource. # Content of the UrlMap to be validated.

5854

#

5855

# Google Compute Engine has two URL Map resources:

5856

#

5857

# * [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)

5858

#

5859

# A URL map resource is a component of certain types of GCP load balancers and Traffic Director.

5860

#

5861

# * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.

5862

#

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5863

# For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table.

5864

#

5865

# For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table.

5866

#

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5867

# This resource defines mappings from host names and URL paths to either a backend service or a backend bucket.

5868

#

5869

# 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.

5870

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

5871

"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.

5872

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

5873

# 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^]

5874

# 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]

5875

"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^]

5876

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5877

"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.

5878

# Default is false.

5879

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

5880

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5881

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5882

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

5883

"A String",

5884

],

5885

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

5886

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5887

"A String",

5888

],

5889

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

5890

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

5891

"A String",

5892

],

5893

"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.

5894

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

5895

"A String",

5896

],

5897

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

5898

},

5899

"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.

5900

# 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^]

5901

# 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]

5902

"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.

5903

"httpStatus": 42, # The HTTP status code used to abort the request.

5904

# The value must be between 200 and 599 inclusive.

5905

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

5906

# The value must be between 0.0 and 100.0 inclusive.

5907

},

5908

"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.

5909

"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.

5910

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5911

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5912

},

5913

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

5914

# The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5915

},

5916

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5917

"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^]

5918

# 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]

5919

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

5920

},

5921

"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^]

5922

# 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]

5923

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

5924

"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.

5925

# 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.

5926

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5927

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5928

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5929

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

5930

# - 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.

5931

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

5932

# -

5933

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

5934

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

5935

# - 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.

5936

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

5937

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

5938

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

5939

# - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

5940

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5941

],

5942

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5943

"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.

5944

# 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^]

5945

# 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]

5946

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

5947

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

5948

},

5949

"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]

5950

# 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^]

5951

# 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]

5952

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5953

# The value must be between 1 and 255 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5954

"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.

5955

# The value must be between 1 and 1024 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

5956

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5957

"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.

5958

# 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]

5959

{ # 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

5960

"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.

5961

"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.

5962

# 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^]

5963

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

5964

# 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]

5965

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

5966

{ # Specification determining how headers are added to requests or responses.

5967

"headerName": "A String", # The name of the header.

5968

"headerValue": "A String", # The value of the header to add.

5969

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5970

# The default value is false.

5971

},

5972

],

5973

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

5974

"A String",

5975

],

5976

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

5977

{ # Specification determining how headers are added to requests or responses.

5978

"headerName": "A String", # The name of the header.

5979

"headerValue": "A String", # The value of the header to add.

5980

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

5981

# The default value is false.

5982

},

5983

],

5984

"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) .

5989

# 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.

5990

# The value must be between 0 and 1000

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5991

},

5992

],

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

5993

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

5994

"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.

5995

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5996

# 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]

5997

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.

5998

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

5999

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6000

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6001

# The value must be between 1 and 255 characters.

6002

"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.

6003

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6004

# The default is set to false.

6005

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6006

# 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.

6007

# The value must be between 1 and 1024 characters.

6008

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6009

# 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.

6010

# The value must be between 1 and 1024 characters.

6011

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6012

# Supported values are:

6013

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6014

# - FOUND, which corresponds to 302.

6015

# - SEE_OTHER which corresponds to 303.

6016

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6017

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6018

"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.

6019

# The default is set to false.

6020

},

6021

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6022

"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.

6023

#

6024

# To see the latest fingerprint, make a get() request to retrieve a UrlMap.

6025

"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.

6026

# The headerAction specified here take effect after headerAction specified under pathMatcher.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6027

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6028

# 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]

6029

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6030

{ # Specification determining how headers are added to requests or responses.

6031

"headerName": "A String", # The name of the header.

6032

"headerValue": "A String", # The value of the header to add.

6033

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6034

# The default value is false.

6035

},

6036

],

6037

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6038

"A String",

6039

],

6040

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6041

{ # Specification determining how headers are added to requests or responses.

6042

"headerName": "A String", # The name of the header.

6043

"headerValue": "A String", # The value of the header to add.

6044

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6045

# The default value is false.

6046

},

6047

],

6048

"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.

6053

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

6054

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6055

"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^]

6056

# * 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]

6057

"A String",

6058

],

6059

"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.

6060

},

6061

],

6062

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

6063

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

6064

"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.

6065

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

6066

{ # 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.

6067

"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.

6068

# Only one of defaultRouteAction or defaultUrlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6069

# 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]

6070

"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^]

6071

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6072

"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.

6073

# Default is false.

6074

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6075

"A String",

6076

],

6077

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6078

"A String",

6079

],

6080

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6081

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6082

"A String",

6083

],

6084

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6085

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6086

"A String",

6087

],

6088

"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.

6089

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6090

"A String",

6091

],

6092

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6093

},

6094

"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.

6095

# 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^]

6096

# 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]

6097

"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.

6098

"httpStatus": 42, # The HTTP status code used to abort the request.

6099

# The value must be between 200 and 599 inclusive.

6100

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6101

# The value must be between 0.0 and 100.0 inclusive.

6102

},

6103

"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.

6104

"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.

6105

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6106

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6107

},

6108

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6109

# The value must be between 0.0 and 100.0 inclusive.

6110

},

6111

},

6112

"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^]

6113

# 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]

6114

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6115

},

6116

"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^]

6117

# 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]

6118

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6119

"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.

6120

# 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.

6121

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6122

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6123

},

6124

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6125

# - 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.

6126

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6127

# -

6128

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6129

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6130

# - 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.

6131

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6132

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6133

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6134

# - 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.

6139

# 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^]

6140

# 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]

6141

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6142

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6143

},

6144

"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]

6145

# 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^]

6146

# 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]

6147

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6148

# The value must be between 1 and 255 characters.

6149

"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.

6150

# The value must be between 1 and 1024 characters.

6151

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6152

"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.

6153

# 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]

6154

{ # 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

6155

"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.

6156

"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.

6157

# 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^]

6158

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6159

# 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]

6160

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6161

{ # Specification determining how headers are added to requests or responses.

6162

"headerName": "A String", # The name of the header.

6163

"headerValue": "A String", # The value of the header to add.

6164

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6165

# The default value is false.

6166

},

6167

],

6168

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6169

"A String",

6170

],

6171

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6172

{ # Specification determining how headers are added to requests or responses.

6173

"headerName": "A String", # The name of the header.

6174

"headerValue": "A String", # The value of the header to add.

6175

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6176

# The default value is false.

6177

},

6178

],

6179

"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) .

6184

# 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.

6185

# 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:

6190

# - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService

6191

# - compute/v1/projects/project/global/backendServices/backendService

6192

# - 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.

6193

# Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.

6194

# Authorization requires one or more of the following Google IAM permissions on the specified resource default_service:

6195

# - compute.backendBuckets.use

6196

# - compute.backendServices.use

6197

"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.

6198

# If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6199

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6200

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6201

# The value must be between 1 and 255 characters.

6202

"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.

6203

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6204

# The default is set to false.

6205

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6206

# 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.

6207

# The value must be between 1 and 1024 characters.

6208

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6209

# 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.

6210

# The value must be between 1 and 1024 characters.

6211

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6212

# Supported values are:

6213

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6214

# - FOUND, which corresponds to 302.

6215

# - SEE_OTHER which corresponds to 303.

6216

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6217

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6218

"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.

6219

# The default is set to false.

6220

},

6221

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

6222

"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.

6223

# 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^]

6224

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6225

# 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]

6226

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6227

{ # Specification determining how headers are added to requests or responses.

6228

"headerName": "A String", # The name of the header.

6229

"headerValue": "A String", # The value of the header to add.

6230

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6231

# The default value is false.

6232

},

6233

],

6234

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6235

"A String",

6236

],

6237

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6238

{ # Specification determining how headers are added to requests or responses.

6239

"headerName": "A String", # The name of the header.

6240

"headerValue": "A String", # The value of the header to add.

6241

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6242

# The default value is false.

6243

},

6244

],

6245

"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.

6250

"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.

6251

# 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.

6252

# Within a given pathMatcher, only one of pathRules or routeRules must be set.

6253

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

6254

"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.

6255

"A String",

6256

],

6257

"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.

6258

# Only one of routeAction or urlRedirect must be set.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

6259

# 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]

6260

"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^]

6261

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6262

"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.

6263

# Default is false.

6264

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6265

"A String",

6266

],

6267

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6268

"A String",

6269

],

6270

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6271

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6272

"A String",

6273

],

6274

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6275

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6276

"A String",

6277

],

6278

"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.

6279

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6280

"A String",

6281

],

6282

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6283

},

6284

"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.

6285

# 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^]

6286

# 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]

6287

"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.

6288

"httpStatus": 42, # The HTTP status code used to abort the request.

6289

# The value must be between 200 and 599 inclusive.

6290

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6291

# The value must be between 0.0 and 100.0 inclusive.

6292

},

6293

"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.

6294

"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.

6295

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6296

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6297

},

6298

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6299

# The value must be between 0.0 and 100.0 inclusive.

6300

},

6301

},

6302

"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^]

6303

# 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]

6304

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6305

},

6306

"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^]

6307

# 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]

6308

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6309

"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.

6310

# 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.

6311

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6312

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6313

},

6314

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6315

# - 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.

6316

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6317

# -

6318

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6319

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6320

# - 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.

6321

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6322

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6323

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6324

# - 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.

6329

# 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^]

6330

# 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]

6331

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6332

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6333

},

6334

"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]

6335

# 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^]

6336

# 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]

6337

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6338

# The value must be between 1 and 255 characters.

6339

"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.

6340

# The value must be between 1 and 1024 characters.

6341

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6342

"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.

6343

# 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]

6344

{ # 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

6345

"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.

6346

"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.

6347

# 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^]

6348

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6349

# 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]

6350

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6351

{ # Specification determining how headers are added to requests or responses.

6352

"headerName": "A String", # The name of the header.

6353

"headerValue": "A String", # The value of the header to add.

6354

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6355

# The default value is false.

6356

},

6357

],

6358

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6359

"A String",

6360

],

6361

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6362

{ # Specification determining how headers are added to requests or responses.

6363

"headerName": "A String", # The name of the header.

6364

"headerValue": "A String", # The value of the header to add.

6365

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6366

# The default value is false.

6367

},

6368

],

6369

"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) .

6374

# 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.

6375

# 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.

6380

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6381

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.

6382

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6383

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6384

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6385

# The value must be between 1 and 255 characters.

6386

"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.

6387

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6388

# The default is set to false.

6389

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6390

# 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.

6391

# The value must be between 1 and 1024 characters.

6392

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6393

# 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.

6394

# The value must be between 1 and 1024 characters.

6395

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6396

# Supported values are:

6397

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6398

# - FOUND, which corresponds to 302.

6399

# - SEE_OTHER which corresponds to 303.

6400

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6401

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6402

"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.

6403

# 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.

6408

# Within a given pathMatcher, you can set only one of pathRules or routeRules.

6409

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

6410

"description": "A String", # The short description conveying the intent of this routeRule.

6411

# The description can have a maximum length of 1024 characters.

6412

"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.

6413

# 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^]

6414

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6415

# 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]

6416

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6417

{ # Specification determining how headers are added to requests or responses.

6418

"headerName": "A String", # The name of the header.

6419

"headerValue": "A String", # The value of the header to add.

6420

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6421

# The default value is false.

6422

},

6423

],

6424

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6425

"A String",

6426

],

6427

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6428

{ # Specification determining how headers are added to requests or responses.

6429

"headerName": "A String", # The name of the header.

6430

"headerValue": "A String", # The value of the header to add.

6431

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6432

# The default value is false.

6433

},

6434

],

6435

"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.

6436

"A String",

6437

],

6438

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6439

"httpFilterConfigs": [ # Outbound route specific configuration for networkservices.HttpFilter resources enabled by Traffic Director. httpFilterConfigs only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

6440

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

6441

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

6442

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

6443

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

6444

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

6445

},

6446

],

6447

"httpFilterMetadata": [ # Outbound route specific metadata supplied to networkservices.HttpFilter resources enabled by Traffic Director. httpFilterMetadata only applies for Loadbalancers with loadBalancingScheme set to INTERNAL_SELF_MANAGED. See ForwardingRule for more details.

6448

# The only configTypeUrl supported is type.googleapis.com/google.protobuf.Struct

6449

# Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

6450

{ # HttpFilterConfiguration supplies additional contextual settings for networkservices.HttpFilter resources enabled by Traffic Director.

6451

"config": "A String", # The configuration needed to enable the networkservices.HttpFilter resource. The configuration must be YAML formatted and only contain fields defined in the protobuf identified in configTypeUrl

6452

"configTypeUrl": "A String", # The fully qualified versioned proto3 type url of the protobuf that the filter expects for its contextual settings, for example: type.googleapis.com/google.protobuf.Struct

6453

"filterName": "A String", # Name of the networkservices.HttpFilter resource this configuration belongs to. This name must be known to the xDS client. Example: envoy.wasm

6454

},

6455

],

6456

"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]

6457

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

6458

"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.

6459

# fullPathMatch must be between 1 and 1024 characters.

6460

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6461

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

6462

{ # matchRule criteria for request header matches.

6463

"exactMatch": "A String", # The value should exactly match contents of exactMatch.

6464

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6465

"headerName": "A String", # The name of the HTTP header to match.

6466

# For matching against the HTTP request's authority, use a headerMatch with the header name ":authority".

6467

# For matching a request's method, use the headerName ":method".

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6468

# 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]

6469

"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.

6470

# The default setting is false.

6471

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch.

6472

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6473

"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.

6474

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6475

"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.

6476

# For example for a range [-5, 0]

6477

# - -3 will match.

6478

# - 0 will not match.

6479

# - 0.25 will not match.

6480

# - -3someString will not match.

6481

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6482

# Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6483

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

6484

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

6485

},

6486

"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

6487

# 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.

6488

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6489

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6490

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch.

6491

# Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

6492

},

6493

],

6494

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive.

6495

# The default value is false.

6496

# ignoreCase must not be used with regexMatch.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6497

# Not supported when the URL map is bound to target gRPC proxy.

6498

"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.

6499

# 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]

6500

# metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.

6501

# 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^]

6502

# 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]

6503

{ # 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.

6504

# 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.

6505

# 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.

6506

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria

6507

# This list must not be empty and can have at the most 64 entries.

6508

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

6509

"name": "A String", # Name of metadata label.

6510

# The name can have a maximum length of 1024 characters and must be at least 1 character long.

6511

"value": "A String", # The value of the label must match the specified value.

6512

# value can have a maximum length of 1024 characters.

6513

},

6514

],

6515

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.

6516

# Supported values are:

6517

# - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata.

6518

# - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

6519

},

6520

],

6521

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.

6522

# The value must be between 1 and 1024 characters.

6523

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6524

"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^]

6525

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6526

{ # HttpRouteRuleMatch criteria for a request's query parameter.

6527

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.

6528

# Only one of presentMatch, exactMatch or regexMatch must be set.

6529

"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.

6530

"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.

6531

# Only one of presentMatch, exactMatch or regexMatch must be set.

6532

"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

6533

# Only one of presentMatch, exactMatch or regexMatch must be set.

6534

# Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

6535

},

6536

],

6537

"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

6538

# Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

6539

# Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

6540

},

6541

],

6542

"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.

6543

# 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.

6544

# 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.

6545

"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.

6546

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6547

# 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]

6548

"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^]

6549

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6550

"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.

6551

# Default is false.

6552

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

6553

"A String",

6554

],

6555

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

6556

"A String",

6557

],

6558

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript

6559

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6560

"A String",

6561

],

6562

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests.

6563

# An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

6564

"A String",

6565

],

6566

"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.

6567

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

6568

"A String",

6569

],

6570

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

6571

},

6572

"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.

6573

# 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^]

6574

# 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]

6575

"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.

6576

"httpStatus": 42, # The HTTP status code used to abort the request.

6577

# The value must be between 200 and 599 inclusive.

6578

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.

6579

# The value must be between 0.0 and 100.0 inclusive.

6580

},

6581

"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.

6582

"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.

6583

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6584

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6585

},

6586

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.

6587

# The value must be between 0.0 and 100.0 inclusive.

6588

},

6589

},

6590

"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^]

6591

# 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]

6592

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

6593

},

6594

"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^]

6595

# 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]

6596

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

6597

"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.

6598

# 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.

6599

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6600

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6601

},

6602

"retryConditions": [ # Specfies one or more conditions when this retry rule applies. Valid values are:

6603

# - 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.

6604

# - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.

6605

# -

6606

# - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts.

6607

# - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409.

6608

# - 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.

6609

# - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled

6610

# - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded

6611

# - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted

6612

# - 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.

6617

# 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^]

6618

# 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]

6619

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

6620

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

6621

},

6622

"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]

6623

# 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^]

6624

# 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]

6625

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.

6626

# The value must be between 1 and 255 characters.

6627

"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.

6628

# The value must be between 1 and 1024 characters.

6629

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6630

"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.

6631

# 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]

6632

{ # 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

6633

"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.

6634

"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.

6635

# 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^]

6636

# Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

6637

# 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]

6638

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

6639

{ # Specification determining how headers are added to requests or responses.

6640

"headerName": "A String", # The name of the header.

6641

"headerValue": "A String", # The value of the header to add.

6642

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6643

# The default value is false.

6644

},

6645

],

6646

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

6647

"A String",

6648

],

6649

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

6650

{ # Specification determining how headers are added to requests or responses.

6651

"headerName": "A String", # The name of the header.

6652

"headerValue": "A String", # The value of the header to add.

6653

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.

6654

# The default value is false.

6655

},

6656

],

6657

"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) .

6662

# 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.

6663

# 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.

6668

# Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

6669

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect.

6670

# If urlRedirect is specified, service or routeAction must not be set.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6671

# Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6672

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request.

6673

# The value must be between 1 and 255 characters.

6674

"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.

6675

# This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.

6676

# The default is set to false.

6677

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request.

6678

# 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.

6679

# The value must be between 1 and 1024 characters.

6680

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.

6681

# 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.

6682

# The value must be between 1 and 1024 characters.

6683

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction.

6684

# Supported values are:

6685

# - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301.

6686

# - FOUND, which corresponds to 302.

6687

# - SEE_OTHER which corresponds to 303.

6688

# - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained.

6689

# - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

6690

"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.

6691

# 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.

6698

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

6699

"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^]

6700

# 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]

6701

{ # Message for the expected URL mappings.

6702

"description": "A String", # Description of this test case.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6703

"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]

6704

"path": "A String", # Path portion of the URL.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6705

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

6706

# service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6707

},

6708

],

6709

},

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

}

Returns:

An object of the form:

6715

6716

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6717

"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.

6722

"testFailures": [

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6723

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

6724

"actualService": "A String", # BackendService or BackendBucket returned by load balancer.

6725

"expectedService": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

6726

"host": "A String", # Host portion of the URL.

6727

"path": "A String", # Path portion including query parameters in the URL.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

6728

},

6729

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

6730

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

Sai Cheemalapati