Reference documentation and code samples for the Google Cloud Network Services V1 Client class Destination.
Specifications of a destination to which the request should be routed to.
Generated from protobuf message google.cloud.networkservices.v1.HttpRoute.Destination
Namespace
Google \ Cloud \ NetworkServices \ V1 \ HttpRouteMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ service_name |
string
The URL of a BackendService to route traffic to. |
↳ weight |
int
Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as: - weight/Sum(weights in this destination list). For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them. |
↳ request_header_modifier |
HeaderModifier
Optional. 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
Optional. 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. |
getServiceName
The URL of a BackendService to route traffic to.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceName
The URL of a BackendService to route traffic to.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWeight
Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as:
- weight/Sum(weights in this destination list).
For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
| Returns | |
|---|---|
| Type | Description |
int |
|
setWeight
Specifies the proportion of requests forwarded to the backend referenced by the serviceName field. This is computed as:
- weight/Sum(weights in this destination list).
For non-zero values, there may be some epsilon from the exact proportion defined here depending on the precision an implementation supports. If only one serviceName is specified and it has a weight greater than 0, 100% of the traffic is forwarded to that backend. If weights are specified for any one service name, they need to be specified for all of them. If weights are unspecified for all services, then, traffic is distributed in equal proportions to all of them.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRequestHeaderModifier
Optional. 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.
| Returns | |
|---|---|
| Type | Description |
HeaderModifier|null |
|
hasRequestHeaderModifier
clearRequestHeaderModifier
setRequestHeaderModifier
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
HeaderModifier
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponseHeaderModifier
Optional. 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.
| Returns | |
|---|---|
| Type | Description |
HeaderModifier|null |
|
hasResponseHeaderModifier
clearResponseHeaderModifier
setResponseHeaderModifier
Optional. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
HeaderModifier
|
| Returns | |
|---|---|
| Type | Description |
$this |
|