Reference documentation and code samples for the Google Cloud Deploy V1 Client class CancelRolloutRequest.
The request object used by CancelRollout.
Generated from protobuf message google.cloud.deploy.v1.CancelRolloutRequest
Methods
build
| Parameter | |
|---|---|
| Name | Description |
name |
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. Please see {@see \Google\Cloud\Deploy\V1\CloudDeployClient::rolloutName()} for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Deploy\V1\CancelRolloutRequest | |
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. |
getName
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |