mirror of
https://github.com/ansible-collections/google.cloud.git
synced 2025-04-09 12:20:27 -07:00
* add defaultRouteAction to url map * update exactly_one_of per review comments * update exactly_one_of for default_url_redirect Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician
GitHub
parent
215727fbd6
commit
deab30ba48
2 changed files with 3127 additions and 1 deletions
File diff suppressed because it is too large
Load diff
|
|
@ -1627,6 +1627,381 @@ resources:
|
||||||
query portion of the original URL is retained.
|
query portion of the original URL is retained.
|
||||||
returned: success
|
returned: success
|
||||||
type: bool
|
type: bool
|
||||||
|
defaultRouteAction:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
weightedBackendServices:
|
||||||
|
description:
|
||||||
|
- A list of weighted backend services to send traffic to when a route
|
||||||
|
match occurs.
|
||||||
|
- The weights determine the fraction of traffic that flows to their
|
||||||
|
corresponding backend service.
|
||||||
|
- If all traffic needs to go to a single backend service, there must
|
||||||
|
be one weightedBackendService with weight set to a non 0 number.
|
||||||
|
- Once a backendService is identified and before forwarding the request
|
||||||
|
to the backend service, advanced routing actions like Url rewrites
|
||||||
|
and header transformations are applied depending on additional settings
|
||||||
|
specified in this HttpRouteAction.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
backendService:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
weight:
|
||||||
|
description:
|
||||||
|
- 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 .
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
headerAction:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
requestHeadersToRemove:
|
||||||
|
description:
|
||||||
|
- A list of header names for headers that need to be removed
|
||||||
|
from the request prior to forwarding the request to the backendService.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
requestHeadersToAdd:
|
||||||
|
description:
|
||||||
|
- Headers to add to a matching request prior to forwarding the
|
||||||
|
request to the backendService.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
headerName:
|
||||||
|
description:
|
||||||
|
- The name of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
headerValue:
|
||||||
|
description:
|
||||||
|
- The value of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
replace:
|
||||||
|
description:
|
||||||
|
- If false, headerValue is appended to any values that already
|
||||||
|
exist for the header.
|
||||||
|
- If true, headerValue is set for the header, discarding
|
||||||
|
any values that were set for that header.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
responseHeadersToRemove:
|
||||||
|
description:
|
||||||
|
- A list of header names for headers that need to be removed
|
||||||
|
from the response prior to sending the response back to the
|
||||||
|
client.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
responseHeadersToAdd:
|
||||||
|
description:
|
||||||
|
- Headers to add the response prior to sending the response
|
||||||
|
back to the client.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
headerName:
|
||||||
|
description:
|
||||||
|
- The name of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
headerValue:
|
||||||
|
description:
|
||||||
|
- The value of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
replace:
|
||||||
|
description:
|
||||||
|
- If false, headerValue is appended to any values that already
|
||||||
|
exist for the header.
|
||||||
|
- If true, headerValue is set for the header, discarding
|
||||||
|
any values that were set for that header.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
urlRewrite:
|
||||||
|
description:
|
||||||
|
- The spec to modify the URL of the request, prior to forwarding the
|
||||||
|
request to the matched service.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
pathPrefixRewrite:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
hostRewrite:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
timeout:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
seconds:
|
||||||
|
description:
|
||||||
|
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
|
||||||
|
inclusive.
|
||||||
|
- 'Note: these bounds are computed from: 60 sec/min * 60 min/hr
|
||||||
|
* 24 hr/day * 365.25 days/year * 10000 years .'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
nanos:
|
||||||
|
description:
|
||||||
|
- Span of time that's a fraction of a second at nanosecond resolution.
|
||||||
|
Durations less than one second are represented with a 0 seconds
|
||||||
|
field and a positive nanos field. Must be from 0 to 999,999,999
|
||||||
|
inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
retryPolicy:
|
||||||
|
description:
|
||||||
|
- Specifies the retry policy associated with this route.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
retryConditions:
|
||||||
|
description:
|
||||||
|
- 'Specfies 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.
|
||||||
|
- 'cancelled: Loadbalancer 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 .'
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
numRetries:
|
||||||
|
description:
|
||||||
|
- Specifies the allowed number retries. This number must be > 0.
|
||||||
|
If not specified, defaults to 1.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
perTryTimeout:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
seconds:
|
||||||
|
description:
|
||||||
|
- Span of time at a resolution of a second. Must be from 0 to
|
||||||
|
315,576,000,000 inclusive.
|
||||||
|
- 'Note: these bounds are computed from: 60 sec/min * 60 min/hr
|
||||||
|
* 24 hr/day * 365.25 days/year * 10000 years .'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
nanos:
|
||||||
|
description:
|
||||||
|
- Span of time that's a fraction of a second at nanosecond resolution.
|
||||||
|
Durations less than one second are represented with a 0 seconds
|
||||||
|
field and a positive nanos field. Must be from 0 to 999,999,999
|
||||||
|
inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
requestMirrorPolicy:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
backendService:
|
||||||
|
description:
|
||||||
|
- The full or partial URL to the BackendService resource being mirrored
|
||||||
|
to.
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
corsPolicy:
|
||||||
|
description:
|
||||||
|
- The specification for allowing client side cross-origin requests.
|
||||||
|
Please see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/)
|
||||||
|
.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
allowOrigins:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
allowOriginRegexes:
|
||||||
|
description:
|
||||||
|
- Specifies the regualar expression patterns that match allowed
|
||||||
|
origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript
|
||||||
|
An origin is allowed if it matches either an item in allowOrigins
|
||||||
|
or an item in allowOriginRegexes.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
allowMethods:
|
||||||
|
description:
|
||||||
|
- Specifies the content for the Access-Control-Allow-Methods header.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
allowHeaders:
|
||||||
|
description:
|
||||||
|
- Specifies the content for the Access-Control-Allow-Headers header.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
exposeHeaders:
|
||||||
|
description:
|
||||||
|
- Specifies the content for the Access-Control-Expose-Headers header.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
maxAge:
|
||||||
|
description:
|
||||||
|
- Specifies how long results of a preflight request can be cached
|
||||||
|
in seconds.
|
||||||
|
- This translates to the Access-Control-Max-Age header.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
allowCredentials:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
disabled:
|
||||||
|
description:
|
||||||
|
- If true, specifies the CORS policy is disabled. The default value
|
||||||
|
is false, which indicates that the CORS policy is in effect.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
faultInjectionPolicy:
|
||||||
|
description:
|
||||||
|
- The specification for fault injection introduced into traffic to test
|
||||||
|
the resiliency of clients to backend service failure.
|
||||||
|
- As part of fault injection, when clients send requests to a backend
|
||||||
|
service, delays can be introduced by Loadbalancer on a percentage
|
||||||
|
of requests before sending those request to the backend service. Similarly
|
||||||
|
requests from clients can be aborted by the Loadbalancer for a percentage
|
||||||
|
of requests.
|
||||||
|
- timeout and retryPolicy will be ignored by clients that are configured
|
||||||
|
with a faultInjectionPolicy.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
delay:
|
||||||
|
description:
|
||||||
|
- The specification for how client requests are delayed as part
|
||||||
|
of fault injection, before being sent to a backend service.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
fixedDelay:
|
||||||
|
description:
|
||||||
|
- Specifies the value of the fixed delay interval.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
seconds:
|
||||||
|
description:
|
||||||
|
- Span of time at a resolution of a second. Must be from
|
||||||
|
0 to 315,576,000,000 inclusive.
|
||||||
|
- 'Note: these bounds are computed from: 60 sec/min * 60
|
||||||
|
min/hr * 24 hr/day * 365.25 days/year * 10000 years .'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
nanos:
|
||||||
|
description:
|
||||||
|
- Span of time that's a fraction of a second at nanosecond
|
||||||
|
resolution. Durations less than one second are represented
|
||||||
|
with a 0 seconds field and a positive nanos field. Must
|
||||||
|
be from 0 to 999,999,999 inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
percentage:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
abort:
|
||||||
|
description:
|
||||||
|
- The specification for how client requests are aborted as part
|
||||||
|
of fault injection.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
httpStatus:
|
||||||
|
description:
|
||||||
|
- The HTTP status code used to abort the request.
|
||||||
|
- The value must be between 200 and 599 inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
percentage:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
tests:
|
tests:
|
||||||
description:
|
description:
|
||||||
- The list of expected URL mapping tests. Request to update this UrlMap will
|
- The list of expected URL mapping tests. Request to update this UrlMap will
|
||||||
|
|
@ -1717,6 +2092,376 @@ resources:
|
||||||
of the original URL is retained. The default is set to false.
|
of the original URL is retained. The default is set to false.
|
||||||
returned: success
|
returned: success
|
||||||
type: bool
|
type: bool
|
||||||
|
defaultRouteAction:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
weightedBackendServices:
|
||||||
|
description:
|
||||||
|
- A list of weighted backend services to send traffic to when a route match
|
||||||
|
occurs.
|
||||||
|
- The weights determine the fraction of traffic that flows to their corresponding
|
||||||
|
backend service.
|
||||||
|
- If all traffic needs to go to a single backend service, there must be
|
||||||
|
one weightedBackendService with weight set to a non 0 number.
|
||||||
|
- Once a backendService is identified and before forwarding the request
|
||||||
|
to the backend service, advanced routing actions like Url rewrites and
|
||||||
|
header transformations are applied depending on additional settings specified
|
||||||
|
in this HttpRouteAction.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
backendService:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
weight:
|
||||||
|
description:
|
||||||
|
- 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 .
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
headerAction:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
requestHeadersToRemove:
|
||||||
|
description:
|
||||||
|
- A list of header names for headers that need to be removed from
|
||||||
|
the request prior to forwarding the request to the backendService.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
requestHeadersToAdd:
|
||||||
|
description:
|
||||||
|
- Headers to add to a matching request prior to forwarding the request
|
||||||
|
to the backendService.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
headerName:
|
||||||
|
description:
|
||||||
|
- The name of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
headerValue:
|
||||||
|
description:
|
||||||
|
- The value of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
replace:
|
||||||
|
description:
|
||||||
|
- If false, headerValue is appended to any values that already
|
||||||
|
exist for the header.
|
||||||
|
- If true, headerValue is set for the header, discarding any
|
||||||
|
values that were set for that header.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
responseHeadersToRemove:
|
||||||
|
description:
|
||||||
|
- A list of header names for headers that need to be removed from
|
||||||
|
the response prior to sending the response back to the client.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
responseHeadersToAdd:
|
||||||
|
description:
|
||||||
|
- Headers to add the response prior to sending the response back
|
||||||
|
to the client.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
headerName:
|
||||||
|
description:
|
||||||
|
- The name of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
headerValue:
|
||||||
|
description:
|
||||||
|
- The value of the header to add.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
replace:
|
||||||
|
description:
|
||||||
|
- If false, headerValue is appended to any values that already
|
||||||
|
exist for the header.
|
||||||
|
- If true, headerValue is set for the header, discarding any
|
||||||
|
values that were set for that header.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
urlRewrite:
|
||||||
|
description:
|
||||||
|
- The spec to modify the URL of the request, prior to forwarding the request
|
||||||
|
to the matched service.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
pathPrefixRewrite:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
hostRewrite:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
timeout:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
seconds:
|
||||||
|
description:
|
||||||
|
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
|
||||||
|
inclusive.
|
||||||
|
- 'Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24
|
||||||
|
hr/day * 365.25 days/year * 10000 years .'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
nanos:
|
||||||
|
description:
|
||||||
|
- Span of time that's a fraction of a second at nanosecond resolution.
|
||||||
|
Durations less than one second are represented with a 0 seconds field
|
||||||
|
and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
retryPolicy:
|
||||||
|
description:
|
||||||
|
- Specifies the retry policy associated with this route.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
retryConditions:
|
||||||
|
description:
|
||||||
|
- 'Specfies 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.
|
||||||
|
- 'cancelled: Loadbalancer 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 .'
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
numRetries:
|
||||||
|
description:
|
||||||
|
- Specifies the allowed number retries. This number must be > 0. If
|
||||||
|
not specified, defaults to 1.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
perTryTimeout:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
seconds:
|
||||||
|
description:
|
||||||
|
- Span of time at a resolution of a second. Must be from 0 to 315,576,000,000
|
||||||
|
inclusive.
|
||||||
|
- 'Note: these bounds are computed from: 60 sec/min * 60 min/hr
|
||||||
|
* 24 hr/day * 365.25 days/year * 10000 years .'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
nanos:
|
||||||
|
description:
|
||||||
|
- Span of time that's a fraction of a second at nanosecond resolution.
|
||||||
|
Durations less than one second are represented with a 0 seconds
|
||||||
|
field and a positive nanos field. Must be from 0 to 999,999,999
|
||||||
|
inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
requestMirrorPolicy:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
backendService:
|
||||||
|
description:
|
||||||
|
- The full or partial URL to the BackendService resource being mirrored
|
||||||
|
to.
|
||||||
|
returned: success
|
||||||
|
type: dict
|
||||||
|
corsPolicy:
|
||||||
|
description:
|
||||||
|
- The specification for allowing client side cross-origin requests. Please
|
||||||
|
see [W3C Recommendation for Cross Origin Resource Sharing](https://www.w3.org/TR/cors/)
|
||||||
|
.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
allowOrigins:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
allowOriginRegexes:
|
||||||
|
description:
|
||||||
|
- Specifies the regualar expression patterns that match allowed origins.
|
||||||
|
For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript
|
||||||
|
An origin is allowed if it matches either an item in allowOrigins
|
||||||
|
or an item in allowOriginRegexes.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
allowMethods:
|
||||||
|
description:
|
||||||
|
- Specifies the content for the Access-Control-Allow-Methods header.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
allowHeaders:
|
||||||
|
description:
|
||||||
|
- Specifies the content for the Access-Control-Allow-Headers header.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
exposeHeaders:
|
||||||
|
description:
|
||||||
|
- Specifies the content for the Access-Control-Expose-Headers header.
|
||||||
|
returned: success
|
||||||
|
type: list
|
||||||
|
maxAge:
|
||||||
|
description:
|
||||||
|
- Specifies how long results of a preflight request can be cached in
|
||||||
|
seconds.
|
||||||
|
- This translates to the Access-Control-Max-Age header.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
allowCredentials:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
disabled:
|
||||||
|
description:
|
||||||
|
- If true, specifies the CORS policy is disabled. The default value
|
||||||
|
is false, which indicates that the CORS policy is in effect.
|
||||||
|
returned: success
|
||||||
|
type: bool
|
||||||
|
faultInjectionPolicy:
|
||||||
|
description:
|
||||||
|
- The specification for fault injection introduced into traffic to test
|
||||||
|
the resiliency of clients to backend service failure.
|
||||||
|
- As part of fault injection, when clients send requests to a backend service,
|
||||||
|
delays can be introduced by Loadbalancer on a percentage of requests before
|
||||||
|
sending those request to the backend service. Similarly requests from
|
||||||
|
clients can be aborted by the Loadbalancer for a percentage of requests.
|
||||||
|
- timeout and retryPolicy will be ignored by clients that are configured
|
||||||
|
with a faultInjectionPolicy.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
delay:
|
||||||
|
description:
|
||||||
|
- The specification for how client requests are delayed as part of fault
|
||||||
|
injection, before being sent to a backend service.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
fixedDelay:
|
||||||
|
description:
|
||||||
|
- Specifies the value of the fixed delay interval.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
seconds:
|
||||||
|
description:
|
||||||
|
- Span of time at a resolution of a second. Must be from 0 to
|
||||||
|
315,576,000,000 inclusive.
|
||||||
|
- 'Note: these bounds are computed from: 60 sec/min * 60 min/hr
|
||||||
|
* 24 hr/day * 365.25 days/year * 10000 years .'
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
nanos:
|
||||||
|
description:
|
||||||
|
- Span of time that's a fraction of a second at nanosecond resolution.
|
||||||
|
Durations less than one second are represented with a 0 seconds
|
||||||
|
field and a positive nanos field. Must be from 0 to 999,999,999
|
||||||
|
inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
percentage:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
|
abort:
|
||||||
|
description:
|
||||||
|
- The specification for how client requests are aborted as part of fault
|
||||||
|
injection.
|
||||||
|
returned: success
|
||||||
|
type: complex
|
||||||
|
contains:
|
||||||
|
httpStatus:
|
||||||
|
description:
|
||||||
|
- The HTTP status code used to abort the request.
|
||||||
|
- The value must be between 200 and 599 inclusive.
|
||||||
|
returned: success
|
||||||
|
type: int
|
||||||
|
percentage:
|
||||||
|
description:
|
||||||
|
- 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.
|
||||||
|
returned: success
|
||||||
|
type: str
|
||||||
'''
|
'''
|
||||||
|
|
||||||
################################################################################
|
################################################################################
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue