Google Cloud Network Services V1 Client - Class RouteAction (0.5.0)

Reference documentation and code samples for the Google Cloud Network Services V1 Client class RouteAction.

Specifies how to route matched traffic.

Generated from protobuf message google.cloud.networkservices.v1.GrpcRoute.RouteAction

Namespace

Google \ Cloud \ NetworkServices \ V1 \ GrpcRoute

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ destinations array<Destination>

Optional. The destination services to which traffic should be forwarded. If multiple destinations are specified, traffic will be split between Backend Service(s) according to the weight field of these destinations.
↳ fault_injection_policy FaultInjectionPolicy

Optional. The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests. timeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy
↳ timeout Google\Protobuf\Duration

Optional. 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 RetryPolicy

Optional. Specifies the retry policy associated with this route.
↳ stateful_session_affinity StatefulSessionAffinityPolicy

Optional. Specifies cookie-based stateful session affinity.
↳ 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

Optional. The destination services to which traffic should be forwarded.

If multiple destinations are specified, traffic will be split between Backend Service(s) according to the weight field of these destinations.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDestinations

Optional. The destination services to which traffic should be forwarded.

If multiple destinations are specified, traffic will be split between Backend Service(s) according to the weight field of these destinations.

Parameter
Name Description
var array<Destination>
Returns
Type Description
$this

getFaultInjectionPolicy

Optional. The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests.

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

Returns
Type Description
FaultInjectionPolicy|null

hasFaultInjectionPolicy

clearFaultInjectionPolicy

setFaultInjectionPolicy

Optional. The specification for fault injection introduced into traffic to test the resiliency of clients to destination service failure. As part of fault injection, when clients send requests to a destination, delays can be introduced on a percentage of requests before sending those requests to the destination service. Similarly requests from clients can be aborted by for a percentage of requests.

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

Parameter
Name Description
var FaultInjectionPolicy
Returns
Type Description
$this

getTimeout

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

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

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

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getRetryPolicy

Optional. Specifies the retry policy associated with this route.

Returns
Type Description
RetryPolicy|null

hasRetryPolicy

clearRetryPolicy

setRetryPolicy

Optional. Specifies the retry policy associated with this route.

Parameter
Name Description
var RetryPolicy
Returns
Type Description
$this

getStatefulSessionAffinity

Optional. Specifies cookie-based stateful session affinity.

Returns
Type Description
StatefulSessionAffinityPolicy|null

hasStatefulSessionAffinity

clearStatefulSessionAffinity

setStatefulSessionAffinity

Optional. Specifies cookie-based stateful session affinity.

Parameter
Name Description
var StatefulSessionAffinityPolicy
Returns
Type Description
$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.

Returns
Type Description
Google\Protobuf\Duration|null

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.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this