Reference documentation and code samples for the Google Cloud Deploy V1 Client class GatewayServiceMesh.
Information about the Kubernetes Gateway API service mesh configuration.
Generated from protobuf message google.cloud.deploy.v1.KubernetesConfig.GatewayServiceMesh
Namespace
Google \ Cloud \ Deploy \ V1 \ KubernetesConfigMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ http_route |
string
Required. Name of the Gateway API HTTPRoute. |
↳ service |
string
Required. Name of the Kubernetes Service. |
↳ deployment |
string
Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service. |
↳ route_update_wait_time |
Google\Protobuf\Duration
Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time. |
↳ stable_cutback_duration |
Google\Protobuf\Duration
Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time. |
↳ pod_selector_label |
string
Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources. |
↳ route_destinations |
Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations
Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster. |
getHttpRoute
Required. Name of the Gateway API HTTPRoute.
| Returns | |
|---|---|
| Type | Description |
string |
|
setHttpRoute
Required. Name of the Gateway API HTTPRoute.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getService
Required. Name of the Kubernetes Service.
| Returns | |
|---|---|
| Type | Description |
string |
|
setService
Required. Name of the Kubernetes Service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDeployment
Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDeployment
Required. Name of the Kubernetes Deployment whose traffic is managed by the specified HTTPRoute and Service.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRouteUpdateWaitTime
Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasRouteUpdateWaitTime
clearRouteUpdateWaitTime
setRouteUpdateWaitTime
Optional. The time to wait for route updates to propagate. The maximum configurable time is 3 hours, in seconds format. If unspecified, there is no wait time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStableCutbackDuration
Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasStableCutbackDuration
clearStableCutbackDuration
setStableCutbackDuration
Optional. The amount of time to migrate traffic back from the canary Service to the original Service during the stable phase deployment. If specified, must be between 15s and 3600s. If unspecified, there is no cutback time.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPodSelectorLabel
Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPodSelectorLabel
Optional. The label to use when selecting Pods for the Deployment and Service resources. This label must already be present in both resources.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRouteDestinations
Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations|null |
|
hasRouteDestinations
clearRouteDestinations
setRouteDestinations
Optional. Route destinations allow configuring the Gateway API HTTPRoute to be deployed to additional clusters. This option is available for multi-cluster service mesh set ups that require the route to exist in the clusters that call the service. If unspecified, the HTTPRoute will only be deployed to the Target cluster.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\KubernetesConfig\GatewayServiceMesh\RouteDestinations
|
| Returns | |
|---|---|
| Type | Description |
$this |
|