Google Cloud Deploy V1 Client - Class ApproveRolloutRequest (0.6.0)

Reference documentation and code samples for the Google Cloud Deploy V1 Client class ApproveRolloutRequest.

The request object used by ApproveRollout.

Generated from protobuf message google.cloud.deploy.v1.ApproveRolloutRequest

Methods

build

Parameter
NameDescription
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
TypeDescription
Google\Cloud\Deploy\V1\ApproveRolloutRequest

__construct

Constructor.

Parameters
NameDescription
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}.

↳ approved bool

Required. True = approve; false = reject

getName

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.

Returns
TypeDescription
string

setName

Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getApproved

Required. True = approve; false = reject

Returns
TypeDescription
bool

setApproved

Required. True = approve; false = reject

Parameter
NameDescription
var bool
Returns
TypeDescription
$this