Reference documentation and code samples for the Google Cloud Deploy V1 Client class IgnoreJobRequest.
The request object used by IgnoreJob
.
Generated from protobuf message google.cloud.deploy.v1.IgnoreJobRequest
Methods
build
Parameters | |
---|---|
Name | Description |
rollout |
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. |
phaseId |
string
Required. The phase ID the Job to ignore belongs to. |
jobId |
string
Required. The job ID for the Job to ignore. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Deploy\V1\IgnoreJobRequest |
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ rollout |
string
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}. |
↳ phase_id |
string
Required. The phase ID the Job to ignore belongs to. |
↳ job_id |
string
Required. The job ID for the Job to ignore. |
getRollout
Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
Returns | |
---|---|
Type | Description |
string |
setRollout
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 |
getPhaseId
Required. The phase ID the Job to ignore belongs to.
Returns | |
---|---|
Type | Description |
string |
setPhaseId
Required. The phase ID the Job to ignore belongs to.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getJobId
Required. The job ID for the Job to ignore.
Returns | |
---|---|
Type | Description |
string |
setJobId
Required. The job ID for the Job to ignore.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |