Reference documentation and code samples for the Google Cloud Deploy V1 Client class Canary.
Canary represents the canary deployment strategy.
Generated from protobuf message google.cloud.deploy.v1.Canary
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ runtime_config |
Google\Cloud\Deploy\V1\RuntimeConfig
Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment. |
↳ canary_deployment |
Google\Cloud\Deploy\V1\CanaryDeployment
Configures the progressive based deployment for a Target. |
↳ custom_canary_deployment |
Google\Cloud\Deploy\V1\CustomCanaryDeployment
Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments. |
getRuntimeConfig
Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\RuntimeConfig|null | |
hasRuntimeConfig
clearRuntimeConfig
setRuntimeConfig
Optional. Runtime specific configurations for the deployment strategy. The runtime configuration is used to determine how Cloud Deploy will split traffic to enable a progressive deployment.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\RuntimeConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCanaryDeployment
Configures the progressive based deployment for a Target.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\CanaryDeployment|null | |
hasCanaryDeployment
setCanaryDeployment
Configures the progressive based deployment for a Target.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\CanaryDeployment
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomCanaryDeployment
Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\CustomCanaryDeployment|null | |
hasCustomCanaryDeployment
setCustomCanaryDeployment
Configures the progressive based deployment for a Target, but allows customizing at the phase level where a phase represents each of the percentage deployments.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Deploy\V1\CustomCanaryDeployment
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMode
| Returns | |
|---|---|
| Type | Description |
string | |