Reference documentation and code samples for the Google Cloud Network Services V1 Client class RouteAction.
The specifications for routing traffic and applying associated policies.
Generated from protobuf message google.cloud.networkservices.v1.HttpRoute.RouteAction
Namespace
Google \ Cloud \ NetworkServices \ V1 \ HttpRouteMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ destinations
↳ redirect
↳ fault_injection_policy
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 on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
↳ request_header_modifier
HeaderModifier
The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
↳ response_header_modifier
HeaderModifier
The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged. Conflicts between the two will not be resolved on the configuration.
↳ url_rewrite
↳ timeout
Google\Protobuf\Duration
Specifies the timeout for 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.
↳ retry_policy
↳ request_mirror_policy
RequestMirrorPolicy
Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
↳ cors_policy
↳ stateful_session_affinity
↳ direct_response
↳ idle_timeout
Google\Protobuf\Duration
Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
getDestinations
The destination to which traffic should be forwarded.
setDestinations
The destination to which traffic should be forwarded.
$this
getRedirect
If set, the request is directed as configured by this field.
hasRedirect
clearRedirect
setRedirect
If set, the request is directed as configured by this field.
$this
getFaultInjectionPolicy
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 on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests.
timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
hasFaultInjectionPolicy
clearFaultInjectionPolicy
setFaultInjectionPolicy
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 on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted for a percentage of requests.
timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
$this
getRequestHeaderModifier
The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
hasRequestHeaderModifier
clearRequestHeaderModifier
setRequestHeaderModifier
The specification for modifying the headers of a matching request prior to delivery of the request to the destination. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
$this
getResponseHeaderModifier
The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
hasResponseHeaderModifier
clearResponseHeaderModifier
setResponseHeaderModifier
The specification for modifying the headers of a response prior to sending the response back to the client. If HeaderModifiers are set on both the Destination and the RouteAction, they will be merged.
Conflicts between the two will not be resolved on the configuration.
$this
getUrlRewrite
The specification for rewrite URL before forwarding requests to the destination.
hasUrlRewrite
clearUrlRewrite
setUrlRewrite
The specification for rewrite URL before forwarding requests to the destination.
$this
getTimeout
Specifies the timeout for 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.
hasTimeout
clearTimeout
setTimeout
Specifies the timeout for 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.
$this
getRetryPolicy
Specifies the retry policy associated with this route.
hasRetryPolicy
clearRetryPolicy
setRetryPolicy
Specifies the retry policy associated with this route.
$this
getRequestMirrorPolicy
Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
hasRequestMirrorPolicy
clearRequestMirrorPolicy
setRequestMirrorPolicy
Specifies the policy on how requests intended for the routes destination are shadowed to a separate mirrored destination. Proxy will not wait for the shadow destination to respond before returning the response. Prior to sending traffic to the shadow service, the host/authority header is suffixed with -shadow.
$this
getCorsPolicy
The specification for allowing client side cross-origin requests.
hasCorsPolicy
clearCorsPolicy
setCorsPolicy
The specification for allowing client side cross-origin requests.
$this
getStatefulSessionAffinity
Optional. Specifies cookie-based stateful session affinity.
hasStatefulSessionAffinity
clearStatefulSessionAffinity
setStatefulSessionAffinity
Optional. Specifies cookie-based stateful session affinity.
$this
getDirectResponse
Optional. Static HTTP Response object to be returned regardless of the request.
hasDirectResponse
clearDirectResponse
setDirectResponse
Optional. Static HTTP Response object to be returned regardless of the request.
$this
getIdleTimeout
Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
hasIdleTimeout
clearIdleTimeout
setIdleTimeout
Optional. Specifies the idle timeout for the selected route. The idle timeout is defined as the period in which there are no bytes sent or received on either the upstream or downstream connection. If not set, the default idle timeout is 1 hour. If set to 0s, the timeout will be disabled.
$this
