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

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

[diff] [blame]

79

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

80

81

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

82

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

83

Dmitry Frenkel

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

[diff] [blame]

84

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

85

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

86

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

87

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

Craig Citro

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

[diff] [blame]

88

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

89

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

90

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

Bu Sun Kim

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

[diff] [blame]

91

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

Craig Citro

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

[diff] [blame]

92

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

93

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

Craig Citro

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

[diff] [blame]

94

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

95

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

96

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

97

<p class="firstline">Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).</p>

Jon Wayne Parrott

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

[diff] [blame]

98

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

99

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

Craig Citro

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

[diff] [blame]

100

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

101

102

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

103

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

104

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

Craig Citro

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

[diff] [blame]

107

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

108

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

Sai Cheemalapati

ea3a5e1

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

[diff] [blame]

109

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

Craig Citro

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

[diff] [blame]

110

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

111

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

Jon Wayne Parrott

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

[diff] [blame]

112

<p class="firstline">Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.</p>

Craig Citro

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

[diff] [blame]

113

<h3>Method Details</h3>

114

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

115

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

Dan O'Meara

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

[diff] [blame]

116

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

117

118

Args:

119

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

120

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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]

121

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]

122

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

123

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

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

[diff] [blame]

124

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

125

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

126

x__xgafv: string, V1 error format.

127

Allowed values

128

1 - v1 error format

129

2 - v2 error format

Dan O'Meara

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

[diff] [blame]

130

131

Returns:

132

An object of the form:

133

134

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

135

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

136

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

137

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

138

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

139

{ # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

140

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

141

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

142

"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 Not supported when the URL map is bound to target gRPC proxy.

143

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

144

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

145

"A String",

146

],

147

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

148

"A String",

149

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

150

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

151

"A String",

152

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

153

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

154

"A String",

155

],

156

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

157

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

158

"A String",

159

],

160

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

161

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

162

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

163

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

164

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

165

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

166

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

167

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

168

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

Bu Sun Kim

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

[diff] [blame]

169

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

170

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

Dan O'Meara

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

[diff] [blame]

171

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

172

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

173

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

174

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

175

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

176

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

177

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

178

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

179

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

180

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

181

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

182

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

183

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

184

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

Bu Sun Kim

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

[diff] [blame]

185

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

186

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

187

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

188

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

189

"A String",

Dan O'Meara

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

[diff] [blame]

190

],

Dan O'Meara

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

[diff] [blame]

191

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

192

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

193

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

194

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

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

[diff] [blame]

195

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

196

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

197

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

198

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

199

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

200

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

201

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

202

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

203

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

204

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

205

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

206

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

207

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

208

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

Bu Sun Kim

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

[diff] [blame]

209

},

210

],

211

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

212

"A String",

213

],

214

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

215

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

216

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

217

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

218

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

Bu Sun Kim

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

[diff] [blame]

219

},

220

],

221

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

222

"A String",

223

],

224

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

225

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

226

},

227

],

228

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

229

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

230

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

231

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

232

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

233

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

234

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

235

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

236

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

237

},

238

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

239

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

240

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

241

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

242

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

243

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

244

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

245

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

246

},

247

],

248

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

249

"A String",

250

],

251

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

252

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

253

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

254

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

255

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

256

},

257

],

258

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

263

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

264

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

265

"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 .. * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

266

"A String",

267

],

268

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

269

},

270

],

271

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

272

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

273

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

274

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

275

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

276

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

277

"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 Not supported when the URL map is bound to target gRPC proxy.

278

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

279

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

280

"A String",

281

],

282

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

283

"A String",

284

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

285

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

286

"A String",

287

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

288

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

289

"A String",

290

],

291

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

292

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

293

"A String",

294

],

295

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

296

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

297

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

298

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

299

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

300

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

301

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

302

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

303

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

304

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

305

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

306

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

307

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

308

},

309

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

310

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

311

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

312

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

313

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

314

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

315

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

316

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

317

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

318

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

319

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

320

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

321

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

322

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

323

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

324

"A String",

325

],

326

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

327

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

328

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

329

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

330

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

331

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

332

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

333

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

334

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

335

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

336

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

337

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

338

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

339

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

340

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

341

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

342

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

343

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

Bu Sun Kim

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

[diff] [blame]

344

},

345

],

346

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

347

"A String",

348

],

349

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

350

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

351

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

352

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

353

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

Bu Sun Kim

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

[diff] [blame]

354

},

355

],

356

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

357

"A String",

358

],

359

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

360

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

361

},

362

],

363

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

364

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

365

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

366

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

367

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

368

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

369

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

370

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

371

"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. The default is set to false.

Bu Sun Kim

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

[diff] [blame]

372

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

373

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

374

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

375

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

376

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

377

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

378

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

379

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

380

},

381

],

382

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

383

"A String",

384

],

385

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

386

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

387

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

388

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

389

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

390

},

391

],

392

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

397

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

398

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

399

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

400

"A String",

401

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

402

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

403

"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 Not supported when the URL map is bound to target gRPC proxy.

404

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

405

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

406

"A String",

407

],

408

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

409

"A String",

410

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

411

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

412

"A String",

413

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

414

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

415

"A String",

416

],

417

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

418

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

419

"A String",

420

],

421

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

422

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

423

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

424

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

425

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

426

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

427

},

428

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

429

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

430

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

431

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

432

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

433

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

434

},

435

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

436

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

437

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

438

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

439

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

440

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

441

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

442

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

443

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

444

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

445

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

446

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

447

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

448

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

449

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

450

"A String",

451

],

452

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

453

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

454

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

455

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

456

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

457

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

458

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

459

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

460

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

461

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

462

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

463

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

464

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

465

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

466

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

467

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

468

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

469

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

470

},

471

],

472

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

473

"A String",

474

],

475

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

476

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

477

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

478

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

479

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

480

},

481

],

482

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

483

"A String",

484

],

485

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

486

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

487

},

488

],

489

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

490

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

491

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

492

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

493

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

494

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

495

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

496

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

497

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

498

},

499

},

500

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

501

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

502

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

503

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

504

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

505

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

506

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

507

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

508

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

509

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

510

},

511

],

512

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

513

"A String",

514

],

515

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

516

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

517

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

518

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

519

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

520

},

521

],

522

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

"A String",

],

},

"matchRules": [ # 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.

527

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

528

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

529

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

530

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

531

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

532

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

533

"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. The default setting is false.

534

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

535

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

536

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

537

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

538

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

539

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

540

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

541

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

542

},

543

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

544

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

545

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

546

{ # 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. 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. 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 of their XDS requests to loadbalancers.

547

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

548

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

549

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

550

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

551

},

552

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

553

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

554

},

555

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

556

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

557

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

558

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

559

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

560

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

561

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

562

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

563

},

564

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

565

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

566

},

567

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

568

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

569

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

570

"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 Not supported when the URL map is bound to target gRPC proxy.

571

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

572

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

573

"A String",

574

],

575

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

576

"A String",

577

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

578

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

579

"A String",

580

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

581

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

582

"A String",

583

],

584

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

585

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

586

"A String",

587

],

588

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

589

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

590

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

591

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

592

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

593

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

594

},

595

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

596

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

597

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

598

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

599

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

600

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

601

},

602

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

603

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

604

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

605

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

606

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

607

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

608

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

609

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

610

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

611

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

612

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

613

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

614

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

615

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

616

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

617

"A String",

618

],

619

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

620

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

621

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

622

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

623

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

624

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

625

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

626

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

627

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

628

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

629

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

630

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

631

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

632

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

633

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

634

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

635

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

636

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

637

},

638

],

639

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

640

"A String",

641

],

642

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

643

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

644

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

645

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

646

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

647

},

648

],

649

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

650

"A String",

651

],

652

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

653

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

654

},

655

],

656

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

657

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

658

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

659

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

660

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

661

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

662

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

663

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

664

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

665

},

666

},

667

],

Dan O'Meara

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

[diff] [blame]

668

},

669

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

670

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

671

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

672

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

673

{ # Message for the expected URL mappings.

674

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

675

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

676

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

677

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

678

{ # HTTP headers used in UrlMapTests.

679

"name": "A String", # Header name.

680

"value": "A String", # Header value.

681

},

682

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

683

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

684

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

685

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

686

},

687

],

Dan O'Meara

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

[diff] [blame]

688

},

689

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

690

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

691

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

692

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

693

{

694

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

695

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

696

},

697

],

698

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

699

},

Dan O'Meara

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

[diff] [blame]

700

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

701

},

702

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

703

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

704

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

705

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

706

"A String",

707

],

708

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

709

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

710

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

711

{

712

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

713

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

714

},

715

],

716

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

717

},

718

}</pre>

Dan O'Meara

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

[diff] [blame]

</div>

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

723

<pre>Retrieves the next page of results.

724

725

Args:

726

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

727

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

728

729

Returns:

Bu Sun Kim

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

[diff] [blame]

730

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

Dan O'Meara

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

[diff] [blame]

731

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]

736

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

737

<pre>Close httplib2 connections.</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

741

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

Craig Citro

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

[diff] [blame]

742

<pre>Deletes the specified UrlMap resource.

743

744

Args:

Jon Wayne Parrott

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

[diff] [blame]

745

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

Craig Citro

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

[diff] [blame]

746

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

747

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

748

x__xgafv: string, V1 error format.

749

Allowed values

750

1 - v1 error format

751

2 - v2 error format

Craig Citro

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

[diff] [blame]

752

753

Returns:

754

An object of the form:

755

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

756

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

757

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

758

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

759

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

760

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

761

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

762

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

Bu Sun Kim

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

[diff] [blame]

763

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

764

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

765

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

766

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

Bu Sun Kim

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

[diff] [blame]

767

},

768

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

769

},

770

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

771

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

772

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

773

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

774

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

775

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

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

776

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

777

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

778

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

779

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

780

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

781

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

782

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

783

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

784

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

785

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

786

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

787

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

788

{

789

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

790

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

791

{

792

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

793

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

794

},

795

],

796

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

797

},

798

],

799

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

800

}</pre>

Craig Citro

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

804

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

Bu Sun Kim

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

[diff] [blame]

805

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

Craig Citro

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

[diff] [blame]

806

807

Args:

Jon Wayne Parrott

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

[diff] [blame]

808

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

Craig Citro

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

[diff] [blame]

809

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

810

x__xgafv: string, V1 error format.

811

Allowed values

812

1 - v1 error format

813

2 - v2 error format

Craig Citro

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

[diff] [blame]

814

815

Returns:

816

An object of the form:

817

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

818

{ # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

819

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

820

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

821

"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 Not supported when the URL map is bound to target gRPC proxy.

822

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

823

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

824

"A String",

825

],

826

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

827

"A String",

828

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

829

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

830

"A String",

831

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

832

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

833

"A String",

834

],

835

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

836

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

837

"A String",

838

],

839

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

840

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

841

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

842

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

843

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

844

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

845

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

846

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

847

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

Bu Sun Kim

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

[diff] [blame]

848

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

849

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

Craig Citro

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

[diff] [blame]

850

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

851

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

852

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

853

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

854

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

855

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

856

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

857

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

858

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

859

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

860

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

861

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

862

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

863

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

Bu Sun Kim

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

[diff] [blame]

864

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

865

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

866

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

867

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

868

"A String",

Craig Citro

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

[diff] [blame]

869

],

Bu Sun Kim

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

[diff] [blame]

870

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

871

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

872

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

873

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

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

[diff] [blame]

874

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

875

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

876

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

877

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

878

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

879

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

880

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

881

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

882

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

883

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

884

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

885

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

886

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

887

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

Bu Sun Kim

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

[diff] [blame]

888

},

889

],

890

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

891

"A String",

892

],

893

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

894

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

895

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

896

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

897

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

Bu Sun Kim

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

[diff] [blame]

898

},

899

],

900

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

901

"A String",

902

],

903

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

904

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

905

},

906

],

907

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

908

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

909

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

910

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

911

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

912

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

913

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

914

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

915

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

916

},

917

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

918

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

919

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

920

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

921

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

922

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

923

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

924

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

925

},

926

],

927

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

928

"A String",

929

],

930

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

931

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

932

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

933

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

934

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

935

},

936

],

937

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

942

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

943

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

944

"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 .. * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

945

"A String",

946

],

947

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

948

},

949

],

950

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

951

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

952

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

953

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

954

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

955

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

956

"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 Not supported when the URL map is bound to target gRPC proxy.

957

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

958

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

959

"A String",

960

],

961

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

962

"A String",

963

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

964

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

965

"A String",

966

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

967

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

968

"A String",

969

],

970

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

971

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

972

"A String",

973

],

974

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

975

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

976

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

977

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

978

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

979

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

980

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

981

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

982

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

983

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

984

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

985

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

986

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

987

},

988

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

989

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

990

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

991

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

992

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

993

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

994

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

995

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

996

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

997

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

998

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

999

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

1000

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

1001

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1002

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1003

"A String",

1004

],

1005

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1006

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1007

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

1008

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

1009

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1010

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1011

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1012

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1013

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1014

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

1015

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1016

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1017

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1018

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

1019

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

1020

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

1021

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1022

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

Bu Sun Kim

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

[diff] [blame]

1023

},

1024

],

1025

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

1026

"A String",

1027

],

1028

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

1029

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

1030

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

1031

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1032

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

Bu Sun Kim

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

[diff] [blame]

1033

},

1034

],

1035

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

1036

"A String",

1037

],

1038

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1039

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

1040

},

1041

],

1042

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1043

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

1044

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1045

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1046

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1047

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1048

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1049

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1050

"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. The default is set to false.

Bu Sun Kim

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

[diff] [blame]

1051

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1052

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1053

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1054

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

1055

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

1056

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

1057

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1058

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1059

},

1060

],

1061

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

1062

"A String",

1063

],

1064

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

1065

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

1066

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

1067

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1068

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1069

},

1070

],

1071

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1076

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1077

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

1078

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

1079

"A String",

1080

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1081

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

1082

"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 Not supported when the URL map is bound to target gRPC proxy.

1083

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1084

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

1085

"A String",

1086

],

1087

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

1088

"A String",

1089

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1090

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1091

"A String",

1092

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1093

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1094

"A String",

1095

],

1096

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

1097

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

1098

"A String",

1099

],

1100

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

1101

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1102

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1103

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1104

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

1105

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1106

},

1107

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

1108

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

1109

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

1110

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

1111

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1112

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1113

},

1114

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1115

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1116

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

1117

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

1118

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1119

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1120

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

1121

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1122

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1123

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1124

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1125

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

1126

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

1127

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1128

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1129

"A String",

1130

],

1131

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1132

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1133

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

1134

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

1135

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1136

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1137

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1138

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1139

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1140

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

1141

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1142

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1143

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1144

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

1145

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

1146

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

1147

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1148

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1149

},

1150

],

1151

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

1152

"A String",

1153

],

1154

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

1155

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

1156

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

1157

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1158

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1159

},

1160

],

1161

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

1162

"A String",

1163

],

1164

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1165

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1166

},

1167

],

1168

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1169

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1170

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1171

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1172

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1173

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1174

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1175

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1176

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1177

},

1178

},

1179

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1180

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1181

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1182

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

1183

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1184

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

1185

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

1186

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

1187

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1188

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1189

},

1190

],

1191

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

1192

"A String",

1193

],

1194

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

1195

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

1196

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

1197

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1198

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1199

},

1200

],

1201

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

"A String",

],

},

"matchRules": [ # 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.

1206

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1207

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1208

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

1209

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1210

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1211

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

1212

"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. The default setting is false.

1213

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1214

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1215

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1216

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

1217

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

1218

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1219

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1220

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1221

},

1222

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1223

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

1224

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1225

{ # 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. 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. 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 of their XDS requests to loadbalancers.

1226

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1227

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1228

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

1229

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1230

},

1231

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1232

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1233

},

1234

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1235

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1236

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1237

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1238

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1239

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1240

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

1241

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1242

},

1243

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1244

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1245

},

1246

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1247

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

1248

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

1249

"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 Not supported when the URL map is bound to target gRPC proxy.

1250

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1251

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

1252

"A String",

1253

],

1254

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

1255

"A String",

1256

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1257

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1258

"A String",

1259

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1260

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1261

"A String",

1262

],

1263

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

1264

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

1265

"A String",

1266

],

1267

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

1268

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1269

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1270

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1271

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

1272

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1273

},

1274

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

1275

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

1276

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

1277

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

1278

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1279

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1280

},

1281

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1282

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1283

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

1284

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

1285

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1286

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1287

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

1288

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1289

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1290

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1291

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1292

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

1293

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

1294

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1295

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1296

"A String",

1297

],

1298

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1299

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1300

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

1301

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

1302

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1303

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1304

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1305

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1306

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1307

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

1308

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1309

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1310

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1311

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

1312

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

1313

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

1314

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1315

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1316

},

1317

],

1318

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

1319

"A String",

1320

],

1321

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

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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

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. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1326

},

1327

],

1328

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

1329

"A String",

1330

],

1331

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1332

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1333

},

1334

],

1335

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1336

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1337

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1338

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1339

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1340

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1341

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1342

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1343

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

},

],

},

],

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

1350

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1351

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1352

{ # Message for the expected URL mappings.

1353

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1354

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

1355

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1356

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

1357

{ # HTTP headers used in UrlMapTests.

1358

"name": "A String", # Header name.

1359

"value": "A String", # Header value.

1360

},

1361

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1362

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

1363

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1364

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1365

},

1366

],

1367

}</pre>

Craig Citro

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

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1371

<code class="details" id="insert">insert(project, body=None, requestId=None, x__xgafv=None)</code>

Craig Citro

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

[diff] [blame]

1372

<pre>Creates a UrlMap resource in the specified project using the data included in the request.

1373

1374

Args:

Jon Wayne Parrott

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

[diff] [blame]

1375

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

Dan O'Meara

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

[diff] [blame]

1376

body: object, The request body.

Craig Citro

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

[diff] [blame]

1377

The object takes the form of:

1378

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1379

{ # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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.

Bu Sun Kim

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

[diff] [blame]

1380

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1381

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1382

"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 Not supported when the URL map is bound to target gRPC proxy.

1383

"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. Default is false.

Bu Sun Kim

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

[diff] [blame]

1384

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

1385

"A String",

Dan O'Meara

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

[diff] [blame]

1386

],

Bu Sun Kim

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

[diff] [blame]

1387

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

1388

"A String",

1389

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1390

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

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

[diff] [blame]

1391

"A String",

1392

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1393

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

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

[diff] [blame]

1394

"A String",

1395

],

1396

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

1397

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

1398

"A String",

1399

],

1400

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

1401

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1402

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

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

[diff] [blame]

1403

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1404

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

1405

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1406

},

1407

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

1408

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

1409

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

1410

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

1411

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1412

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

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

[diff] [blame]

1413

},

1414

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1415

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1416

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

1417

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

1418

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1419

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1420

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

1421

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1422

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1423

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1424

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

Bu Sun Kim

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

[diff] [blame]

1425

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

1426

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

Craig Citro

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

[diff] [blame]

1427

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1428

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

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

[diff] [blame]

1429

"A String",

Dan O'Meara

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

[diff] [blame]

1430

],

1431

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1432

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is 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

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1437

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1438

"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. The value must be between 1 and 1024 characters.

Dan O'Meara

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

[diff] [blame]

1439

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1440

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

1441

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

Bu Sun Kim

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

[diff] [blame]

1442

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1443

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1444

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

1445

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

1446

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

1447

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1448

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

Bu Sun Kim

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

[diff] [blame]

1449

},

1450

],

1451

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

1452

"A String",

1453

],

1454

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

1455

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

1456

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

1457

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1458

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

Bu Sun Kim

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

[diff] [blame]

1459

},

1460

],

1461

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

1462

"A String",

1463

],

1464

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1465

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Craig Citro

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

[diff] [blame]

1466

},

1467

],

Bu Sun Kim

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

[diff] [blame]

1468

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1469

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1470

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1471

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1472

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1473

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1474

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1475

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1476

"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. The default is set to false.

Bu Sun Kim

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

[diff] [blame]

1477

},

1478

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1479

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

1480

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1481

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

1482

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

1483

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

1484

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1485

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

Bu Sun Kim

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

[diff] [blame]

1486

},

1487

],

1488

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

1489

"A String",

1490

],

1491

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

1492

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

1493

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

1494

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1495

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

Bu Sun Kim

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

[diff] [blame]

1496

},

1497

],

1498

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

1503

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

1504

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1505

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

1506

"A String",

1507

],

1508

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

1509

},

1510

],

1511

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

1512

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

1513

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

1514

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

1515

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1516

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

1517

"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 Not supported when the URL map is bound to target gRPC proxy.

1518

"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. Default is false.

Bu Sun Kim

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

[diff] [blame]

1519

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

1520

"A String",

1521

],

1522

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

1523

"A String",

1524

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1525

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

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

[diff] [blame]

1526

"A String",

1527

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1528

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

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

[diff] [blame]

1529

"A String",

1530

],

1531

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

1532

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

1533

"A String",

1534

],

1535

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

1536

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1537

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

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

[diff] [blame]

1538

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1539

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

1540

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1541

},

1542

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

1543

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

1544

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

1545

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

1546

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1547

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1548

},

1549

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1550

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1551

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

1552

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

1553

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1554

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1555

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

1556

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1557

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1558

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1559

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

Bu Sun Kim

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

[diff] [blame]

1560

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

1561

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

1562

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1563

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

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

[diff] [blame]

1564

"A String",

1565

],

1566

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1567

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1568

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

1569

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

1570

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1571

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1572

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1573

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1574

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1575

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

1576

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

Bu Sun Kim

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

[diff] [blame]

1577

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1578

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is 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

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

1580

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

1581

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

1582

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1583

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

Bu Sun Kim

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

[diff] [blame]

1584

},

1585

],

1586

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

1587

"A String",

1588

],

1589

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

1590

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

1591

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

1592

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1593

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

Bu Sun Kim

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

[diff] [blame]

1594

},

1595

],

1596

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

1597

"A String",

1598

],

1599

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1600

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

1601

},

1602

],

1603

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1604

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

1605

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1606

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1607

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1608

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1609

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1610

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1611

"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. The default is set to false.

Bu Sun Kim

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

[diff] [blame]

1612

},

1613

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1614

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1615

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

1616

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

1617

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

1618

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1619

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

Bu Sun Kim

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

[diff] [blame]

1620

},

1621

],

1622

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

1623

"A String",

1624

],

1625

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

1626

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

1627

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

1628

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1629

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

Bu Sun Kim

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

[diff] [blame]

1630

},

1631

],

1632

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1637

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Bu Sun Kim

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

[diff] [blame]

1638

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

1639

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

1640

"A String",

1641

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1642

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

1643

"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 Not supported when the URL map is bound to target gRPC proxy.

1644

"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. Default is false.

Bu Sun Kim

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

[diff] [blame]

1645

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

1646

"A String",

1647

],

1648

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

1649

"A String",

1650

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1651

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

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

[diff] [blame]

1652

"A String",

1653

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1654

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

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

[diff] [blame]

1655

"A String",

1656

],

1657

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

1658

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

1659

"A String",

1660

],

1661

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

1662

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1663

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

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

[diff] [blame]

1664

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1665

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

1666

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1667

},

1668

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

1669

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

1670

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

1671

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

1672

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1673

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

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

[diff] [blame]

1674

},

1675

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1676

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1677

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

1678

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

1679

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1680

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1681

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

1682

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1683

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1684

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1685

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

Bu Sun Kim

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

[diff] [blame]

1686

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

1687

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

1688

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1689

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

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

[diff] [blame]

1690

"A String",

1691

],

1692

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1693

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1694

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

1695

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

1696

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1697

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1698

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1699

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1700

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1701

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

1702

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

Bu Sun Kim

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

[diff] [blame]

1703

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1705

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

1706

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

1707

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

1708

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1709

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

Bu Sun Kim

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

[diff] [blame]

1710

},

1711

],

1712

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

1713

"A String",

1714

],

1715

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

1716

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

1717

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

1718

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1719

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

Bu Sun Kim

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

[diff] [blame]

1720

},

1721

],

1722

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

1723

"A String",

1724

],

1725

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1726

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

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

[diff] [blame]

1727

},

1728

],

1729

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1730

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1731

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1732

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1733

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1734

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1735

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1736

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1737

"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. The default is set to false.

Bu Sun Kim

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

[diff] [blame]

1738

},

1739

},

1740

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1741

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Bu Sun Kim

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

[diff] [blame]

1742

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1743

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

1744

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

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

[diff] [blame]

1745

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

1746

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

1747

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

1748

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1749

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

Bu Sun Kim

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

[diff] [blame]

1750

},

1751

],

1752

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

1753

"A String",

1754

],

1755

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

1756

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

1757

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

1758

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1759

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

Bu Sun Kim

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

[diff] [blame]

1760

},

1761

],

1762

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

1763

"A String",

1764

],

1765

},

Dmitry Frenkel

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

[diff] [blame]

1766

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

1767

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1768

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Bu Sun Kim

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

[diff] [blame]

1769

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

1770

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1771

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1772

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

1773

"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. The default setting is false.

1774

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1775

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

1776

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Bu Sun Kim

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

[diff] [blame]

1777

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

1778

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

1779

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1780

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

1781

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Bu Sun Kim

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

[diff] [blame]

1782

},

1783

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1784

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

1785

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1786

{ # 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. 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. 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 of their XDS requests to loadbalancers.

1787

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Bu Sun Kim

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

[diff] [blame]

1788

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1789

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

1790

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Bu Sun Kim

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

[diff] [blame]

1791

},

1792

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1793

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Bu Sun Kim

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

[diff] [blame]

1794

},

1795

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1796

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

1797

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

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

[diff] [blame]

1798

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1799

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Bu Sun Kim

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

[diff] [blame]

1800

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

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1801

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

1802

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

1803

},

1804

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1805

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

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

[diff] [blame]

1806

},

1807

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1808

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

1809

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

1810

"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 Not supported when the URL map is bound to target gRPC proxy.

1811

"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. Default is false.

Bu Sun Kim

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

[diff] [blame]

1812

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

1813

"A String",

1814

],

1815

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

1816

"A String",

1817

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1818

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1819

"A String",

1820

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1821

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1822

"A String",

1823

],

1824

"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.

1825

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

1826

"A String",

1827

],

1828

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

1829

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1830

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1831

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1832

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

1833

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1834

},

1835

"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.

1836

"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.

1837

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1838

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1839

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1840

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1841

},

1842

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1843

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

1844

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1845

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1846

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1847

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1848

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

1849

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1850

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1851

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1852

"perTryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies a non-zero timeout per retry attempt. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1853

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1854

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1855

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1856

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1857

"A String",

1858

],

1859

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1860

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1861

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

1862

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

1863

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1864

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

1865

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

1866

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1867

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1868

"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. 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.

1869

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1870

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1871

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1872

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

1873

{ # Specification determining how headers are added to requests or responses.

1874

"headerName": "A String", # The name of the header.

1875

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1876

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1877

},

1878

],

1879

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

1880

"A String",

1881

],

1882

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

1883

{ # Specification determining how headers are added to requests or responses.

1884

"headerName": "A String", # The name of the header.

1885

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1886

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1887

},

1888

],

1889

"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.

1890

"A String",

1891

],

1892

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1893

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1894

},

1895

],

1896

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1897

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

1898

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

1899

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

1900

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

1901

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

1902

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

1903

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

1904

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

},

],

"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.

1911

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1912

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1913

{ # Message for the expected URL mappings.

1914

"description": "A String", # Description of this test case.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1915

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

1916

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1917

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

1918

{ # HTTP headers used in UrlMapTests.

1919

"name": "A String", # Header name.

1920

"value": "A String", # Header value.

1921

},

1922

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1923

"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]

1924

"path": "A String", # Path portion of the URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1925

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to. service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1926

},

1927

],

1928

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1929

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1930

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

1931

x__xgafv: string, V1 error format.

1932

Allowed values

1933

1 - v1 error format

1934

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

1935

1936

Returns:

1937

An object of the form:

1938

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1939

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1940

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

1941

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

1942

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

1943

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

1944

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

1945

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1946

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1947

"code": "A String", # [Output Only] The error type identifier for this error.

1948

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

1949

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1950

},

1951

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1952

},

1953

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

1954

"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.

1955

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

1956

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

1957

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

1958

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

1959

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1960

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

1961

"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.

1962

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

1963

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

1964

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

1965

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

1966

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

1967

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

1968

"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.

1969

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

1970

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

1971

{

1972

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1973

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1974

{

1975

"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).

1976

"value": "A String", # [Output Only] A warning data value corresponding to the key.

1977

},

1978

],

1979

"message": "A String", # [Output Only] A human-readable description of the warning code.

1980

},

1981

],

1982

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

1983

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

1987

<code class="details" id="invalidateCache">invalidateCache(project, urlMap, body=None, requestId=None, x__xgafv=None)</code>

1988

<pre>Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content).

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

1989

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1990

Args:

1991

project: string, Project ID for this request. (required)

1992

urlMap: string, Name of the UrlMap scoping this request. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1993

body: object, The request body.

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

1994

The object takes the form of:

1995

1996

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

1997

"host": "A String", # If set, this invalidation rule will only apply to requests with a Host header matching host.

1998

"path": "A String",

1999

}

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2000

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2001

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

2002

x__xgafv: string, V1 error format.

2003

Allowed values

2004

1 - v1 error format

2005

2 - v2 error format

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

2006

2007

Returns:

2008

An object of the form:

2009

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2010

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2011

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

2012

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

2013

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

2014

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

2015

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

2016

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2017

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2018

"code": "A String", # [Output Only] The error type identifier for this error.

2019

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

2020

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2021

},

2022

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2023

},

2024

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

2025

"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.

2026

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

2027

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

2028

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

2029

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2030

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2031

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

2032

"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.

2033

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

2034

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

2035

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

2036

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

2037

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

2038

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

2039

"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.

2040

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

2041

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

2042

{

2043

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2044

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2045

{

2046

"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).

2047

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2048

},

2049

],

2050

"message": "A String", # [Output Only] A human-readable description of the warning code.

2051

},

2052

],

2053

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

2054

}</pre>

Jon Wayne Parrott

2016-08-16 12:44:29 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2058

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2059

<pre>Retrieves the list of UrlMap resources available to the specified project.

2060

2061

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2062

project: string, Project ID for this request. (required)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2063

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 `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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. 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) ```

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2064

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`)

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2065

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2066

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.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2067

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2068

x__xgafv: string, V1 error format.

2069

Allowed values

2070

1 - v1 error format

2071

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2072

2073

Returns:

2074

An object of the form:

2075

2076

{ # Contains a list of UrlMap resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2077

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

2078

"items": [ # A list of UrlMap resources.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2079

{ # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2080

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2081

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2082

"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 Not supported when the URL map is bound to target gRPC proxy.

2083

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2084

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2085

"A String",

2086

],

2087

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2088

"A String",

2089

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2090

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2091

"A String",

2092

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2093

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2094

"A String",

2095

],

2096

"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.

2097

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2098

"A String",

2099

],

2100

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2101

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2102

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2103

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2104

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2105

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2106

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2107

"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.

2108

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2109

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2110

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2111

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2112

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2113

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2114

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2115

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2116

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2117

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2118

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2119

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2120

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2121

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2122

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2123

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2124

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2125

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2126

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2127

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2128

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2129

"A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2130

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2131

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2132

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2133

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2134

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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

2020-05-20 12:08:20 -0700

[diff] [blame]

2135

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2136

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2137

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2138

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2139

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2140

"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. 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.

2141

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2142

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2143

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2144

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2145

{ # Specification determining how headers are added to requests or responses.

2146

"headerName": "A String", # The name of the header.

2147

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2148

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2149

},

2150

],

2151

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2152

"A String",

2153

],

2154

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2155

{ # Specification determining how headers are added to requests or responses.

2156

"headerName": "A String", # The name of the header.

2157

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2158

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2159

},

2160

],

2161

"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.

2162

"A String",

2163

],

2164

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2165

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2166

},

2167

],

2168

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2169

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2170

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

2171

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

2172

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

2173

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

2174

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

2175

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2176

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2177

},

2178

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2179

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2180

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2181

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2182

{ # Specification determining how headers are added to requests or responses.

2183

"headerName": "A String", # The name of the header.

2184

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2185

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2186

},

2187

],

2188

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2189

"A String",

2190

],

2191

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2192

{ # Specification determining how headers are added to requests or responses.

2193

"headerName": "A String", # The name of the header.

2194

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2195

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2196

},

2197

],

2198

"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.

2203

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2204

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2205

"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 .. * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2206

"A String",

2207

],

2208

"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.

2209

},

2210

],

2211

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2212

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2213

"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.

2214

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2215

{ # 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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2216

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

2217

"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 Not supported when the URL map is bound to target gRPC proxy.

2218

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2219

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2220

"A String",

2221

],

2222

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2223

"A String",

2224

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2225

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2226

"A String",

2227

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2228

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2229

"A String",

2230

],

2231

"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.

2232

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2233

"A String",

2234

],

2235

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2236

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2237

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2238

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2239

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2240

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2241

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2242

"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.

2243

"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.

2244

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2245

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2246

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2247

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2248

},

2249

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2250

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2251

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2252

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2253

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2254

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2255

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2256

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2257

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2258

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2259

"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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2260

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2261

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2262

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2263

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2264

"A String",

2265

],

2266

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2267

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2268

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2269

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2270

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2271

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2272

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2273

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2274

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2275

"weightedBackendServices": [ # A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. 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.

2276

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2277

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2278

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2279

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2280

{ # Specification determining how headers are added to requests or responses.

2281

"headerName": "A String", # The name of the header.

2282

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2283

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2284

},

2285

],

2286

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2287

"A String",

2288

],

2289

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2290

{ # Specification determining how headers are added to requests or responses.

2291

"headerName": "A String", # The name of the header.

2292

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2293

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2294

},

2295

],

2296

"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.

2297

"A String",

2298

],

2299

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2300

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2301

},

2302

],

2303

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2304

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

2305

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

2306

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

2307

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

2308

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

2309

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

2310

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2311

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2312

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2313

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2314

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2315

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2316

{ # Specification determining how headers are added to requests or responses.

2317

"headerName": "A String", # The name of the header.

2318

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2319

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2320

},

2321

],

2322

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2323

"A String",

2324

],

2325

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2326

{ # Specification determining how headers are added to requests or responses.

2327

"headerName": "A String", # The name of the header.

2328

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2329

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2330

},

2331

],

2332

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2337

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2338

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2339

"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.

2340

"A String",

2341

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2342

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

2343

"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 Not supported when the URL map is bound to target gRPC proxy.

2344

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2345

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2346

"A String",

2347

],

2348

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2349

"A String",

2350

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2351

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2352

"A String",

2353

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2354

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2355

"A String",

2356

],

2357

"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.

2358

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2359

"A String",

2360

],

2361

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2362

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2363

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2364

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2365

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2366

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2367

},

2368

"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.

2369

"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.

2370

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2371

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2372

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2373

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2374

},

2375

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2376

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2377

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2378

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2379

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2380

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2381

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2382

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2383

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2384

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2385

"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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2386

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2387

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2388

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2389

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2390

"A String",

2391

],

2392

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2393

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2394

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2395

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2396

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2397

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2398

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2399

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2400

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2401

"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. 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.

2402

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2403

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2404

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2405

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2406

{ # Specification determining how headers are added to requests or responses.

2407

"headerName": "A String", # The name of the header.

2408

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2409

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2410

},

2411

],

2412

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2413

"A String",

2414

],

2415

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2416

{ # Specification determining how headers are added to requests or responses.

2417

"headerName": "A String", # The name of the header.

2418

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2419

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2420

},

2421

],

2422

"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.

2423

"A String",

2424

],

2425

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2426

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2427

},

2428

],

2429

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2430

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2431

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

2432

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

2433

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

2434

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

2435

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

2436

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2437

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2438

},

2439

},

2440

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2441

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2442

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2443

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

2444

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2445

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2446

{ # Specification determining how headers are added to requests or responses.

2447

"headerName": "A String", # The name of the header.

2448

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2449

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2450

},

2451

],

2452

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2453

"A String",

2454

],

2455

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2456

{ # Specification determining how headers are added to requests or responses.

2457

"headerName": "A String", # The name of the header.

2458

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2459

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2460

},

2461

],

2462

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [ # 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.

2467

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2468

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2469

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

2470

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2471

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2472

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

2473

"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. The default setting is false.

2474

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2475

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

2476

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2477

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

2478

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

2479

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2480

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

2481

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2482

},

2483

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2484

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

2485

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2486

{ # 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. 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. 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 of their XDS requests to loadbalancers.

2487

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2488

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2489

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

2490

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2491

},

2492

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2493

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2494

},

2495

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2496

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

2497

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2498

{ # HttpRouteRuleMatch criteria for a request's query parameter.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2499

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2500

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2501

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

2502

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2503

},

2504

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2505

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2506

},

2507

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2508

"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. 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. 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.

2509

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

2510

"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 Not supported when the URL map is bound to target gRPC proxy.

2511

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2512

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2513

"A String",

2514

],

2515

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2516

"A String",

2517

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2518

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2519

"A String",

2520

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2521

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2522

"A String",

2523

],

2524

"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.

2525

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2526

"A String",

2527

],

2528

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2529

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2530

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2531

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2532

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2533

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2534

},

2535

"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.

2536

"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.

2537

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2538

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2539

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2540

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2541

},

2542

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2543

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2544

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2545

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2546

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2547

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2548

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2549

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2550

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2551

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2552

"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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2553

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2554

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2555

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2556

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2557

"A String",

2558

],

2559

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2560

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2561

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2562

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2563

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2564

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2565

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2566

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2567

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2568

"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. 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.

2569

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2570

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2571

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2572

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2573

{ # Specification determining how headers are added to requests or responses.

2574

"headerName": "A String", # The name of the header.

2575

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2576

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2577

},

2578

],

2579

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2580

"A String",

2581

],

2582

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2583

{ # Specification determining how headers are added to requests or responses.

2584

"headerName": "A String", # The name of the header.

2585

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2586

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2587

},

2588

],

2589

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

2590

"A String",

2591

],

2592

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2593

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2594

},

2595

],

2596

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2597

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

2598

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

2599

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

2600

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

2601

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

2602

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

2603

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2604

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2605

},

2606

},

2607

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2608

},

2609

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2610

"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.

2611

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2612

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2613

{ # Message for the expected URL mappings.

2614

"description": "A String", # Description of this test case.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2615

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

2616

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

2617

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

2618

{ # HTTP headers used in UrlMapTests.

2619

"name": "A String", # Header name.

2620

"value": "A String", # Header value.

2621

},

2622

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2623

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

2624

"path": "A String", # Path portion of the URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2625

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to. service cannot be set if expectedRedirectResponseCode is set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2626

},

2627

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2628

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2629

],

2630

"kind": "compute#urlMapList", # Type of resource.

2631

"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.

2632

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

2633

"warning": { # [Output Only] Informational warning message.

2634

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2635

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

2636

{

2637

"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).

2638

"value": "A String", # [Output Only] A warning data value corresponding to the key.

2639

},

2640

],

2641

"message": "A String", # [Output Only] A human-readable description of the warning code.

2642

},

2643

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2648

<pre>Retrieves the next page of results.

2649

2650

Args:

2651

previous_request: The request for the previous page. (required)

2652

previous_response: The response from the request for the previous page. (required)

2653

2654

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2655

A request object that you can call 'execute()' on to request the next

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2656

page. Returns None if there are no more items in the collection.

</pre>

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2661

<code class="details" id="patch">patch(project, urlMap, body=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2662

<pre>Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2663

2664

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2665

project: string, Project ID for this request. (required)

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

2666

urlMap: string, Name of the UrlMap resource to patch. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2667

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2668

The object takes the form of:

2669

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2670

{ # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2671

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2672

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2673

"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 Not supported when the URL map is bound to target gRPC proxy.

2674

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2675

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2676

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2677

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2678

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2679

"A String",

2680

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2681

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2682

"A String",

2683

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2684

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2685

"A String",

2686

],

2687

"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.

2688

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2689

"A String",

2690

],

2691

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2692

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2693

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2694

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2695

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2696

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2697

},

2698

"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.

2699

"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.

2700

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2701

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2702

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2703

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2704

},

2705

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2706

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2707

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2708

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2709

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2710

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2711

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2712

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2713

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2714

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2715

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2716

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2717

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2718

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2719

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2720

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2721

],

2722

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2723

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2724

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2725

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2726

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2727

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2728

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2729

"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. The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2730

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2731

"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. 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.

2732

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2733

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2734

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is 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

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2736

{ # Specification determining how headers are added to requests or responses.

2737

"headerName": "A String", # The name of the header.

2738

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2739

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2740

},

2741

],

2742

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2743

"A String",

2744

],

2745

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2746

{ # Specification determining how headers are added to requests or responses.

2747

"headerName": "A String", # The name of the header.

2748

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2749

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2750

},

2751

],

2752

"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.

2753

"A String",

2754

],

2755

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2756

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

2757

},

2758

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2759

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2760

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2761

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

2762

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

2763

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

2764

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

2765

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

2766

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2767

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2768

},

2769

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2770

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

2771

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2772

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2773

{ # Specification determining how headers are added to requests or responses.

2774

"headerName": "A String", # The name of the header.

2775

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2776

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2777

},

2778

],

2779

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2780

"A String",

2781

],

2782

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2783

{ # Specification determining how headers are added to requests or responses.

2784

"headerName": "A String", # The name of the header.

2785

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2786

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2787

},

2788

],

2789

"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.

2794

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

2795

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2796

"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 .. * 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]

2797

"A String",

2798

],

2799

"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.

2800

},

2801

],

2802

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

2803

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

2804

"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.

2805

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

2806

{ # 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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2807

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

2808

"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 Not supported when the URL map is bound to target gRPC proxy.

2809

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2810

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2811

"A String",

2812

],

2813

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2814

"A String",

2815

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2816

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2817

"A String",

2818

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2819

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2820

"A String",

2821

],

2822

"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.

2823

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2824

"A String",

2825

],

2826

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2827

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2828

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2829

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2830

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2831

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2832

},

2833

"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.

2834

"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.

2835

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2836

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2837

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2838

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2839

},

2840

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2841

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2842

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2843

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2844

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2845

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2846

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2847

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2848

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2849

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2850

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2851

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2852

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2853

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2854

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2855

"A String",

2856

],

2857

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2858

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2859

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2860

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2861

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2862

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2863

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2864

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2865

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2866

"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. 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.

2867

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2868

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2869

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2870

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2871

{ # Specification determining how headers are added to requests or responses.

2872

"headerName": "A String", # The name of the header.

2873

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2874

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2875

},

2876

],

2877

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2878

"A String",

2879

],

2880

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2881

{ # Specification determining how headers are added to requests or responses.

2882

"headerName": "A String", # The name of the header.

2883

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2884

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2885

},

2886

],

2887

"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.

2888

"A String",

2889

],

2890

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2891

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2892

},

2893

],

2894

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2895

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

2896

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

2897

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

2898

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

2899

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

2900

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

2901

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

2902

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2903

},

2904

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2905

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2906

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2907

{ # Specification determining how headers are added to requests or responses.

2908

"headerName": "A String", # The name of the header.

2909

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2910

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2911

},

2912

],

2913

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

2914

"A String",

2915

],

2916

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

2917

{ # Specification determining how headers are added to requests or responses.

2918

"headerName": "A String", # The name of the header.

2919

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2920

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2921

},

2922

],

2923

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2928

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2929

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

2930

"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.

2931

"A String",

2932

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2933

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

2934

"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 Not supported when the URL map is bound to target gRPC proxy.

2935

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2936

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

2937

"A String",

2938

],

2939

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

2940

"A String",

2941

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2942

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2943

"A String",

2944

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2945

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2946

"A String",

2947

],

2948

"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.

2949

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

2950

"A String",

2951

],

2952

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

2953

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2954

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2955

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2956

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

2957

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2958

},

2959

"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.

2960

"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.

2961

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2962

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2963

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2964

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2965

},

2966

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2967

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

2968

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2969

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2970

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2971

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2972

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

2973

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2974

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2975

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2976

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2977

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2978

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2979

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2980

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2981

"A String",

2982

],

2983

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2984

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2985

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

2986

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

2987

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2988

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

2989

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

2990

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2991

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2992

"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. 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.

2993

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2994

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

2995

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2996

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

2997

{ # Specification determining how headers are added to requests or responses.

2998

"headerName": "A String", # The name of the header.

2999

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3000

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3001

},

3002

],

3003

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3004

"A String",

3005

],

3006

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3007

{ # Specification determining how headers are added to requests or responses.

3008

"headerName": "A String", # The name of the header.

3009

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3010

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3011

},

3012

],

3013

"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.

3014

"A String",

3015

],

3016

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3017

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3018

},

3019

],

3020

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3021

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3022

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3023

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3024

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3025

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

3026

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

3027

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3028

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3029

},

3030

},

3031

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3032

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3033

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3034

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

3035

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3036

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3037

{ # Specification determining how headers are added to requests or responses.

3038

"headerName": "A String", # The name of the header.

3039

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3040

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3041

},

3042

],

3043

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3044

"A String",

3045

],

3046

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3047

{ # Specification determining how headers are added to requests or responses.

3048

"headerName": "A String", # The name of the header.

3049

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3050

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3051

},

3052

],

3053

"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.

3054

"A String",

3055

],

3056

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3057

"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]

3058

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3059

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3060

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3061

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3062

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3063

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

3064

"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. The default setting is false.

3065

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3066

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3067

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3068

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3069

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3070

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3071

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

3072

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3073

},

3074

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3075

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

3076

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3077

{ # 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. 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. 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 of their XDS requests to loadbalancers.

3078

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3079

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3080

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

3081

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3082

},

3083

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3084

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3085

},

3086

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3087

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3088

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3089

{ # HttpRouteRuleMatch criteria for a request's query parameter.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3090

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3091

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3092

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

3093

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3094

},

3095

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3096

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3097

},

3098

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3099

"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. 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. 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.

3100

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

3101

"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 Not supported when the URL map is bound to target gRPC proxy.

3102

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3103

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3104

"A String",

3105

],

3106

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3107

"A String",

3108

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3109

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3110

"A String",

3111

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3112

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3113

"A String",

3114

],

3115

"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.

3116

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3117

"A String",

3118

],

3119

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3120

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3121

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3122

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3123

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

3124

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3125

},

3126

"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.

3127

"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.

3128

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3129

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3130

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3131

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3132

},

3133

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3134

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3135

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3136

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3137

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3138

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3139

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3140

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3141

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3142

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3143

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3144

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3145

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3146

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3147

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3148

"A String",

3149

],

3150

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3151

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3152

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3153

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3154

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3155

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3156

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

3157

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3158

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3159

"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. 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.

3160

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3161

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3162

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3163

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3164

{ # Specification determining how headers are added to requests or responses.

3165

"headerName": "A String", # The name of the header.

3166

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3167

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3168

},

3169

],

3170

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3171

"A String",

3172

],

3173

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3174

{ # Specification determining how headers are added to requests or responses.

3175

"headerName": "A String", # The name of the header.

3176

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3177

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3178

},

3179

],

3180

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

3181

"A String",

3182

],

3183

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3184

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3185

},

3186

],

3187

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3188

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3189

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3190

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3191

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3192

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

3193

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

3194

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3195

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

},

],

"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.

3202

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3203

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3204

{ # Message for the expected URL mappings.

3205

"description": "A String", # Description of this test case.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3206

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

3207

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3208

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

3209

{ # HTTP headers used in UrlMapTests.

3210

"name": "A String", # Header name.

3211

"value": "A String", # Header value.

3212

},

3213

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3214

"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]

3215

"path": "A String", # Path portion of the URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3216

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to. service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3217

},

3218

],

3219

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3220

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3221

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3222

x__xgafv: string, V1 error format.

3223

Allowed values

3224

1 - v1 error format

3225

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3226

3227

Returns:

3228

An object of the form:

3229

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3230

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3231

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3232

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3233

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3234

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3235

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3236

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3237

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3238

"code": "A String", # [Output Only] The error type identifier for this error.

3239

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3240

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3241

},

3242

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3243

},

3244

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3245

"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.

3246

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3247

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3248

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3249

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3250

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3251

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3252

"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.

3253

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3254

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3255

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3256

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3257

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3258

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3259

"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.

3260

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3261

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3262

{

3263

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3264

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3265

{

3266

"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).

3267

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3268

},

3269

],

3270

"message": "A String", # [Output Only] A human-readable description of the warning code.

3271

},

3272

],

3273

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3274

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3278

<code class="details" id="update">update(project, urlMap, body=None, requestId=None, x__xgafv=None)</code>

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

3279

<pre>Updates the specified UrlMap resource with the data included in the request.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3280

3281

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3282

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3283

urlMap: string, Name of the UrlMap resource to update. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3284

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3285

The object takes the form of:

3286

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3287

{ # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3288

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3289

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3290

"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 Not supported when the URL map is bound to target gRPC proxy.

3291

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3292

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3293

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3294

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3295

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3296

"A String",

3297

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3298

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3299

"A String",

3300

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3301

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3302

"A String",

3303

],

3304

"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.

3305

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3306

"A String",

3307

],

3308

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3309

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3310

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3311

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3312

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

3313

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3314

},

3315

"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.

3316

"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.

3317

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3318

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3319

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3320

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3321

},

3322

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3323

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3324

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3325

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3326

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3327

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3328

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3329

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3330

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3331

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3332

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3333

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3334

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3335

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3336

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3337

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3338

],

3339

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3340

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3341

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3342

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3343

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3344

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3345

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

3346

"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. The value must be between 1 and 1024 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3347

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3348

"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. 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.

3349

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3350

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3351

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3352

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3353

{ # Specification determining how headers are added to requests or responses.

3354

"headerName": "A String", # The name of the header.

3355

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3356

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3357

},

3358

],

3359

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3360

"A String",

3361

],

3362

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3363

{ # Specification determining how headers are added to requests or responses.

3364

"headerName": "A String", # The name of the header.

3365

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3366

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3367

},

3368

],

3369

"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.

3370

"A String",

3371

],

3372

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3373

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3374

},

3375

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3376

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3377

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3378

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3379

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3380

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3381

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

3382

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

3383

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3384

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3385

},

3386

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3387

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

3388

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3389

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3390

{ # Specification determining how headers are added to requests or responses.

3391

"headerName": "A String", # The name of the header.

3392

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3393

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3394

},

3395

],

3396

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3397

"A String",

3398

],

3399

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3400

{ # Specification determining how headers are added to requests or responses.

3401

"headerName": "A String", # The name of the header.

3402

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3403

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3404

},

3405

],

3406

"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.

3411

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

3412

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3413

"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 .. * 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]

3414

"A String",

3415

],

3416

"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.

3417

},

3418

],

3419

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

3420

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

3421

"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.

3422

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

3423

{ # 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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3424

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

3425

"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 Not supported when the URL map is bound to target gRPC proxy.

3426

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3427

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3428

"A String",

3429

],

3430

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3431

"A String",

3432

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3433

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3434

"A String",

3435

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3436

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3437

"A String",

3438

],

3439

"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.

3440

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3441

"A String",

3442

],

3443

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3444

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3445

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3446

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3447

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

3448

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3449

},

3450

"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.

3451

"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.

3452

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3453

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3454

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3455

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3456

},

3457

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3458

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3459

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3460

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3461

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3462

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3463

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3464

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3465

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3466

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3467

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3468

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3469

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3470

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3471

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3472

"A String",

3473

],

3474

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3475

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3476

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3477

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3478

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3479

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3480

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

3481

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3482

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3483

"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. 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.

3484

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3485

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3486

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3487

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3488

{ # Specification determining how headers are added to requests or responses.

3489

"headerName": "A String", # The name of the header.

3490

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3491

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3492

},

3493

],

3494

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3495

"A String",

3496

],

3497

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3498

{ # Specification determining how headers are added to requests or responses.

3499

"headerName": "A String", # The name of the header.

3500

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3501

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3502

},

3503

],

3504

"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.

3505

"A String",

3506

],

3507

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3508

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3509

},

3510

],

3511

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3512

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

3513

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3514

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3515

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3516

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

3517

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

3518

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3519

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3520

},

3521

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3522

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3523

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3524

{ # Specification determining how headers are added to requests or responses.

3525

"headerName": "A String", # The name of the header.

3526

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3527

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3528

},

3529

],

3530

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3531

"A String",

3532

],

3533

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3534

{ # Specification determining how headers are added to requests or responses.

3535

"headerName": "A String", # The name of the header.

3536

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3537

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3538

},

3539

],

3540

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3545

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3546

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

3547

"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.

3548

"A String",

3549

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3550

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

3551

"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 Not supported when the URL map is bound to target gRPC proxy.

3552

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3553

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3554

"A String",

3555

],

3556

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3557

"A String",

3558

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3559

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3560

"A String",

3561

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3562

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3563

"A String",

3564

],

3565

"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.

3566

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3567

"A String",

3568

],

3569

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3570

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3571

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3572

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3573

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

3574

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3575

},

3576

"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.

3577

"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.

3578

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3579

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3580

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3581

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3582

},

3583

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3584

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3585

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3586

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3587

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3588

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3589

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3590

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3591

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3592

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3593

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3594

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3595

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3596

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3597

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3598

"A String",

3599

],

3600

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3601

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3602

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3603

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3604

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3605

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3606

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

3607

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3608

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3609

"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. 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.

3610

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3611

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3612

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3613

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3614

{ # Specification determining how headers are added to requests or responses.

3615

"headerName": "A String", # The name of the header.

3616

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3617

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3618

},

3619

],

3620

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3621

"A String",

3622

],

3623

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3624

{ # Specification determining how headers are added to requests or responses.

3625

"headerName": "A String", # The name of the header.

3626

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3627

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3628

},

3629

],

3630

"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.

3631

"A String",

3632

],

3633

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3634

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3635

},

3636

],

3637

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3638

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3639

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3640

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3641

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3642

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

3643

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

3644

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3645

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3646

},

3647

},

3648

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3649

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3650

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3651

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

3652

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3653

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3654

{ # Specification determining how headers are added to requests or responses.

3655

"headerName": "A String", # The name of the header.

3656

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3657

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3658

},

3659

],

3660

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3661

"A String",

3662

],

3663

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3664

{ # Specification determining how headers are added to requests or responses.

3665

"headerName": "A String", # The name of the header.

3666

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3667

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3668

},

3669

],

3670

"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.

3671

"A String",

3672

],

3673

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3674

"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]

3675

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3676

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3677

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

3678

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3679

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3680

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

3681

"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. The default setting is false.

3682

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3683

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

3684

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3685

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

3686

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

3687

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3688

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3690

},

3691

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3692

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

3693

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3694

{ # 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. 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. 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 of their XDS requests to loadbalancers.

3695

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3696

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3697

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

3698

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3699

},

3700

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3701

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3702

},

3703

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3704

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

3705

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3706

{ # HttpRouteRuleMatch criteria for a request's query parameter.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3707

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3708

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3709

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

3710

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3711

},

3712

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3713

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3714

},

3715

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3716

"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. 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. 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.

3717

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

3718

"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 Not supported when the URL map is bound to target gRPC proxy.

3719

"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. Default is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3720

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3721

"A String",

3722

],

3723

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3724

"A String",

3725

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3726

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3727

"A String",

3728

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3729

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3730

"A String",

3731

],

3732

"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.

3733

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3734

"A String",

3735

],

3736

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3737

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3738

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3739

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3740

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

3741

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3742

},

3743

"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.

3744

"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.

3745

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3746

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3747

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3748

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3749

},

3750

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3751

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3752

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3753

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3754

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3755

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3756

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3757

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3758

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3759

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3760

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3761

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3762

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3763

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3764

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3765

"A String",

3766

],

3767

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3768

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3769

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3770

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3771

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3772

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3773

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

3774

"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. The value must be between 1 and 1024 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3775

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3776

"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. 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.

3777

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3778

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3779

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3780

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3781

{ # Specification determining how headers are added to requests or responses.

3782

"headerName": "A String", # The name of the header.

3783

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3784

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3785

},

3786

],

3787

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3788

"A String",

3789

],

3790

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3791

{ # Specification determining how headers are added to requests or responses.

3792

"headerName": "A String", # The name of the header.

3793

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3794

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3795

},

3796

],

3797

"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.

3798

"A String",

3799

],

3800

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3801

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3802

},

3803

],

3804

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3805

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

3806

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3807

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3808

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3809

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

3810

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

3811

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

3812

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

},

],

},

],

"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.

3819

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3820

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3821

{ # Message for the expected URL mappings.

3822

"description": "A String", # Description of this test case.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3823

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

3824

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3825

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

3826

{ # HTTP headers used in UrlMapTests.

3827

"name": "A String", # Header name.

3828

"value": "A String", # Header value.

3829

},

3830

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

3831

"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]

3832

"path": "A String", # Path portion of the URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3833

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to. service cannot be set if expectedRedirectResponseCode is set.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3834

},

3835

],

3836

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3837

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3838

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. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).

3839

x__xgafv: string, V1 error format.

3840

Allowed values

3841

1 - v1 error format

3842

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3843

3844

Returns:

3845

An object of the form:

3846

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3847

{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/v1/globalOperations) * [Regional](/compute/docs/reference/rest/v1/regionOperations) * [Zonal](/compute/docs/reference/rest/v1/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3848

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

3849

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

3850

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

3851

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

3852

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

3853

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3854

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3855

"code": "A String", # [Output Only] The error type identifier for this error.

3856

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

3857

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3858

},

3859

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3860

},

3861

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

3862

"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.

3863

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

3864

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

3865

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

3866

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

3867

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3868

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

3869

"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.

3870

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

3871

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

3872

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

3873

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

3874

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

3875

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

3876

"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.

3877

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

3878

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

3879

{

3880

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3881

"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3882

{

3883

"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).

3884

"value": "A String", # [Output Only] A warning data value corresponding to the key.

3885

},

3886

],

3887

"message": "A String", # [Output Only] A human-readable description of the warning code.

3888

},

3889

],

3890

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

3891

}</pre>

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

</div>

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3895

<code class="details" id="validate">validate(project, urlMap, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3896

<pre>Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3897

3898

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

3899

project: string, Project ID for this request. (required)

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3900

urlMap: string, Name of the UrlMap resource to be validated as. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3901

body: object, The request body.

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3902

The object takes the form of:

3903

3904

{

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3905

"resource": { # Represents a URL Map resource. Google Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/v1/urlMaps) * [Regional](/compute/docs/reference/rest/v1/regionUrlMaps) A URL map resource is a component of certain types of GCP load balancers and Traffic Director. * urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers. For a list of supported URL map features by load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from host names and URL paths to either a backend service or a backend bucket. 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. # Content of the UrlMap to be validated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3906

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3907

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within defaultRouteAction. defaultRouteAction has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3908

"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 Not supported when the URL map is bound to target gRPC proxy.

3909

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3910

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

3911

"A String",

3912

],

3913

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

3914

"A String",

3915

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3916

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3917

"A String",

3918

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3919

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3920

"A String",

3921

],

3922

"disabled": True or False, # If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

3923

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

3924

"A String",

3925

],

3926

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

3927

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3928

"faultInjectionPolicy": { # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. # The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3929

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3930

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

3931

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3932

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3933

"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.

3934

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3935

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3936

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3937

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3938

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

3939

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3940

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3941

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

3942

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3943

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3944

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3945

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3946

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

3947

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3948

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3949

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3950

"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. 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3951

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3952

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

3953

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3954

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3955

"A String",

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3956

],

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

3957

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3958

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3959

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

3960

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,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

2020-05-20 12:08:20 -0700

[diff] [blame]

3961

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3962

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3963

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

3964

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3965

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3966

"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. 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.

3967

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3968

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3969

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3970

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

3971

{ # Specification determining how headers are added to requests or responses.

3972

"headerName": "A String", # The name of the header.

3973

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3974

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3975

},

3976

],

3977

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

3978

"A String",

3979

],

3980

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

3981

{ # Specification determining how headers are added to requests or responses.

3982

"headerName": "A String", # The name of the header.

3983

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3984

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3985

},

3986

],

3987

"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.

3988

"A String",

3989

],

3990

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3991

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

3992

},

3993

],

3994

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

3995

"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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

3996

"defaultUrlRedirect": { # Specifies settings for an HTTP redirect. # When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

3997

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

3998

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

3999

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

4000

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

4001

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4002

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4003

},

4004

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4005

"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. To see the latest fingerprint, make a get() request to retrieve a UrlMap.

4006

"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. The headerAction specified here take effect after headerAction specified under pathMatcher. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4007

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4008

{ # Specification determining how headers are added to requests or responses.

4009

"headerName": "A String", # The name of the header.

4010

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4011

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4012

},

4013

],

4014

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4015

"A String",

4016

],

4017

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4018

{ # Specification determining how headers are added to requests or responses.

4019

"headerName": "A String", # The name of the header.

4020

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4021

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4022

},

4023

],

4024

"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.

4029

{ # UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.

4030

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4031

"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 .. * based matching is not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4032

"A String",

4033

],

4034

"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.

4035

},

4036

],

4037

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

4038

"kind": "compute#urlMap", # [Output Only] Type of the resource. Always compute#urlMaps for url maps.

4039

"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.

4040

"pathMatchers": [ # The list of named PathMatchers to use against the URL.

4041

{ # 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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4042

"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. Only one of defaultRouteAction or defaultUrlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathMatcher's defaultRouteAction.

4043

"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 Not supported when the URL map is bound to target gRPC proxy.

4044

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4045

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4046

"A String",

4047

],

4048

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4049

"A String",

4050

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4051

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4052

"A String",

4053

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4054

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4055

"A String",

4056

],

4057

"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.

4058

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4059

"A String",

4060

],

4061

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4062

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4063

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4064

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4065

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

4066

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4067

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4068

"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.

4069

"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.

4070

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4071

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4072

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4073

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4074

},

4075

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4076

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4077

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4078

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4079

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4080

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4081

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4082

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4083

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4084

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4085

"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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4086

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4087

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4088

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4089

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4090

"A String",

4091

],

4092

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4093

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4094

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4095

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4096

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4097

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

4098

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

4099

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4100

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4101

"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. 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.

4102

{ # In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4103

"backendService": "A String", # The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4104

"headerAction": { # The request and response header transformations that take effect before the request is passed along to the selected backendService. # Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4105

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4106

{ # Specification determining how headers are added to requests or responses.

4107

"headerName": "A String", # The name of the header.

4108

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4109

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4110

},

4111

],

4112

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4113

"A String",

4114

],

4115

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4116

{ # Specification determining how headers are added to requests or responses.

4117

"headerName": "A String", # The name of the header.

4118

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4119

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4120

},

4121

],

4122

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

4123

"A String",

4124

],

4125

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4126

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4127

},

4128

],

4129

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4130

"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: - https://www.googleapis.com/compute/v1/projects/project /global/backendServices/backendService - compute/v1/projects/project/global/backendServices/backendService - 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. Only one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set. Authorization requires one or more of the following Google IAM permissions on the specified resource default_service: - compute.backendBuckets.use - compute.backendServices.use

4131

"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. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

4132

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

4133

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

4134

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

4135

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

4136

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4137

"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. The default is set to false.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

4138

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4139

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4140

"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. HeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4141

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4142

{ # Specification determining how headers are added to requests or responses.

4143

"headerName": "A String", # The name of the header.

4144

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4145

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4146

},

4147

],

4148

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4149

"A String",

4150

],

4151

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4152

{ # Specification determining how headers are added to requests or responses.

4153

"headerName": "A String", # The name of the header.

4154

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4155

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4156

},

4157

],

4158

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4163

"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. 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. Within a given pathMatcher, only one of pathRules or routeRules must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4164

{ # A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.

4165

"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.

4166

"A String",

4167

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4168

"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. Only one of routeAction or urlRedirect must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a pathRule's routeAction.

4169

"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 Not supported when the URL map is bound to target gRPC proxy.

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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4171

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4172

"A String",

4173

],

4174

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4175

"A String",

4176

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4177

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4178

"A String",

4179

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4180

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4181

"A String",

4182

],

4183

"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.

4184

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4185

"A String",

4186

],

4187

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4188

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4189

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4190

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4191

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

4192

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4193

},

4194

"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.

4195

"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.

4196

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4197

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4198

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4199

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4200

},

4201

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4202

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

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

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4206

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4207

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4208

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4209

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4210

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4211

"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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4212

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4213

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4214

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4215

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4216

"A String",

4217

],

4218

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4219

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4220

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4221

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4222

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4223

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

4224

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

4225

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4226

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4227

"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. 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.

4228

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4229

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4230

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4231

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4232

{ # Specification determining how headers are added to requests or responses.

4233

"headerName": "A String", # The name of the header.

4234

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4235

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4236

},

4237

],

4238

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4239

"A String",

4240

],

4241

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4242

{ # Specification determining how headers are added to requests or responses.

4243

"headerName": "A String", # The name of the header.

4244

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4245

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4246

},

4247

],

4248

"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.

4249

"A String",

4250

],

4251

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4252

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4253

},

4254

],

4255

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4256

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4257

"urlRedirect": { # Specifies settings for an HTTP redirect. # When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

4258

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

4259

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

4260

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

4261

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

4262

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4263

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4264

},

4265

},

4266

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4267

"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. Within a given pathMatcher, you can set only one of pathRules or routeRules.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4268

{ # An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4269

"description": "A String", # The short description conveying the intent of this routeRule. The description can have a maximum length of 1024 characters.

4270

"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. The headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4271

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4272

{ # Specification determining how headers are added to requests or responses.

4273

"headerName": "A String", # The name of the header.

4274

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4275

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4276

},

4277

],

4278

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4279

"A String",

4280

],

4281

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4282

{ # Specification determining how headers are added to requests or responses.

4283

"headerName": "A String", # The name of the header.

4284

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4285

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4286

},

4287

],

4288

"responseHeadersToRemove": [ # A list of header names for headers that need to be removed from the response prior to sending the response back to the client.

"A String",

],

},

"matchRules": [ # 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.

4293

{ # HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4294

"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. fullPathMatch must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4295

"headerMatches": [ # Specifies a list of header match criteria, all of which must match corresponding headers in the request.

4296

{ # matchRule criteria for request header matches.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4297

"exactMatch": "A String", # The value should exactly match contents of exactMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4298

"headerName": "A String", # The name of the HTTP header to match. For matching against the HTTP request's authority, use a headerMatch with the header name ":authority". For matching a request's method, use the headerName ":method". 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.

4299

"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. The default setting is false.

4300

"prefixMatch": "A String", # The value of the header must start with the contents of prefixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4301

"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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

4302

"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. For example for a range [-5, 0] - -3 will match. - 0 will not match. - 0.25 will not match. - -3someString will not match. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4303

"rangeEnd": "A String", # The end of the range (exclusive) in signed long integer format.

4304

"rangeStart": "A String", # The start of the range (inclusive) in signed long integer format.

4305

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4306

"regexMatch": "A String", # The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: github.com/google/re2/wiki/Syntax 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. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

4307

"suffixMatch": "A String", # The value of the header must end with the contents of suffixMatch. Only one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4308

},

4309

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4310

"ignoreCase": True or False, # Specifies that prefixMatch and fullPathMatch matches are case sensitive. The default value is false. ignoreCase must not be used with regexMatch. Not supported when the URL map is bound to target gRPC proxy.

4311

"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. 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. metadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

4312

{ # 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. 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. 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 of their XDS requests to loadbalancers.

4313

"filterLabels": [ # The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4314

{ # MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4315

"name": "A String", # Name of metadata label. The name can have a maximum length of 1024 characters and must be at least 1 character long.

4316

"value": "A String", # The value of the label must match the specified value. value can have a maximum length of 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4317

},

4318

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4319

"filterMatchCriteria": "A String", # Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. Supported values are: - MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. - MATCH_ALL: All filterLabels must have matching labels in the provided metadata.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4320

},

4321

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4322

"prefixMatch": "A String", # For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /. The value must be between 1 and 1024 characters. Only one of prefixMatch, fullPathMatch or regexMatch must be specified.

4323

"queryParameterMatches": [ # Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request. Not supported when the URL map is bound to target gRPC proxy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4324

{ # HttpRouteRuleMatch criteria for a request's query parameter.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4325

"exactMatch": "A String", # The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch. Only one of presentMatch, exactMatch or regexMatch must be set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4326

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4327

"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. Only one of presentMatch, exactMatch or regexMatch must be set.

4328

"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 github.com/google/re2/wiki/Syntax Only one of presentMatch, exactMatch or regexMatch must be set. Note that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4329

},

4330

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4331

"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 github.com/google/re2/wiki/Syntax Only one of prefixMatch, fullPathMatch or regexMatch must be specified. Note that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4332

},

4333

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4334

"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. 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. 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.

4335

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set. UrlMaps for external HTTP(S) load balancers support only the urlRewrite action within a routeRule's routeAction.

4336

"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 Not supported when the URL map is bound to target gRPC proxy.

4337

"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. Default is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4338

"allowHeaders": [ # Specifies the content for the Access-Control-Allow-Headers header.

4339

"A String",

4340

],

4341

"allowMethods": [ # Specifies the content for the Access-Control-Allow-Methods header.

4342

"A String",

4343

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4344

"allowOriginRegexes": [ # Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see github.com/google/re2/wiki/Syntax An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4345

"A String",

4346

],

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4347

"allowOrigins": [ # Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4348

"A String",

4349

],

4350

"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.

4351

"exposeHeaders": [ # Specifies the content for the Access-Control-Expose-Headers header.

4352

"A String",

4353

],

4354

"maxAge": 42, # Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.

4355

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4356

"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. For the requests impacted by fault injection, timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4357

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4358

"httpStatus": 42, # The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive. For gRPC protocol, the gRPC status code is mapped to HTTP status code according to this mapping table. HTTP status 200 is mapped to gRPC status UNKNOWN. Injecting an OK status is currently not supported by Traffic Director.

4359

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4360

},

4361

"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.

4362

"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.

4363

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4364

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4365

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4366

"percentage": 3.14, # The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4367

},

4368

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4369

"maxStreamDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (i.e. end-of-stream), the duration in this field is computed from the beginning of the stream until the response has been completely processed, including all retries. A stream that does not complete in this duration is closed. If not specified, will use the largest maxStreamDuration among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

4370

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4371

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4372

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4373

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4374

"backendService": "A String", # The full or partial URL to the BackendService resource being mirrored to.

4375

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4376

"retryPolicy": { # The retry policy associates with HttpRouteRule # Specifies the retry policy associated with this route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4377

"numRetries": 42, # Specifies the allowed number retries. This number must be > 0. If not specified, defaults to 1.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4378

"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. 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.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4379

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4380

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4381

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4382

"retryConditions": [ # Specifies one or more conditions when this retry rule applies. Valid values are: - 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. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - 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. - cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4383

"A String",

4384

],

4385

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4386

"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. If not specified, will use the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4387

"nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.

4388

"seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years

4389

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4390

"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. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

4391

"hostRewrite": "A String", # Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

4392

"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. The value must be between 1 and 1024 characters.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4393

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4394

"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. 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.

4395

{ # 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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4396

"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.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4397

"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. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Note that headerAction is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4398

"requestHeadersToAdd": [ # Headers to add to a matching request prior to forwarding the request to the backendService.

4399

{ # Specification determining how headers are added to requests or responses.

4400

"headerName": "A String", # The name of the header.

4401

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4402

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4403

},

4404

],

4405

"requestHeadersToRemove": [ # A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.

4406

"A String",

4407

],

4408

"responseHeadersToAdd": [ # Headers to add the response prior to sending the response back to the client.

4409

{ # Specification determining how headers are added to requests or responses.

4410

"headerName": "A String", # The name of the header.

4411

"headerValue": "A String", # The value of the header to add.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4412

"replace": True or False, # If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header. The default value is false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4413

},

4414

],

4415

"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.

4416

"A String",

4417

],

4418

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4419

"weight": 42, # Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . 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. The value must be between 0 and 1000

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4420

},

4421

],

4422

},

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4423

"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. Only one of urlRedirect, service or routeAction.weightedBackendService must be set.

4424

"urlRedirect": { # Specifies settings for an HTTP redirect. # When this rule is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Not supported when the URL map is bound to target gRPC proxy.

4425

"hostRedirect": "A String", # The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

4426

"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. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

4427

"pathRedirect": "A String", # The path that will be used in the redirect response instead of the one that was supplied in the request. 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. The value must be between 1 and 1024 characters.

4428

"prefixRedirect": "A String", # The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. 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. The value must be between 1 and 1024 characters.

4429

"redirectResponseCode": "A String", # The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

4430

"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. The default is set to false.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

},

],

},

],

"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.

4437

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4438

"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. Not supported when the URL map is bound to target gRPC proxy that has validateForProxyless field set to true.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4439

{ # Message for the expected URL mappings.

4440

"description": "A String", # Description of this test case.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4441

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to https. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.

4442

"expectedRedirectResponseCode": 42, # For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4443

"headers": [ # HTTP headers for this request. If headers contains a host header, then host must also match the header value.

4444

{ # HTTP headers used in UrlMapTests.

4445

"name": "A String", # Header name.

4446

"value": "A String", # Header value.

4447

},

4448

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4449

"host": "A String", # Host portion of the URL. If headers contains a host header, then host must also match the header value.

4450

"path": "A String", # Path portion of the URL.

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4451

"service": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to. service cannot be set if expectedRedirectResponseCode is set.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

},

],

},

}

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4456

yoshi-code-bot

2021-06-16 00:22:06 -0700

[diff] [blame^]

4457

x__xgafv: string, V1 error format.

4458

Allowed values

4459

1 - v1 error format

4460

2 - v2 error format

Craig Citro

2014-08-14 00:47:23 -0700

[diff] [blame]

4461

4462

Returns:

4463

An object of the form:

4464

4465

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4466

"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.

4471

"testFailures": [

4472

{

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4473

"actualOutputUrl": "A String", # The actual output URL evaluated by load balancer containing the scheme, host, path and query parameters.

4474

"actualRedirectResponseCode": 42, # Actual HTTP status code for rule with `urlRedirect` calculated by load balancer

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4475

"actualService": "A String", # BackendService or BackendBucket returned by load balancer.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4476

"expectedOutputUrl": "A String", # The expected output URL evaluated by load balancer containing the scheme, host, path and query parameters.

4477

"expectedRedirectResponseCode": 42, # Expected HTTP status code for rule with `urlRedirect` calculated by load balancer

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4478

"expectedService": "A String", # Expected BackendService or BackendBucket resource the given URL should be mapped to.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

4479

"headers": [ # HTTP headers of the request.

4480

{ # HTTP headers used in UrlMapTests.

4481

"name": "A String", # Header name.

4482

"value": "A String", # Header value.

4483

},

4484

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

4485

"host": "A String", # Host portion of the URL.

4486

"path": "A String", # Path portion including query parameters in the URL.

4487

},

4488

],

4489

"testPassed": True or False, # If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.

4490

},

4491

}</pre>

Craig Citro