Google Cloud Ai Platform V1 Client - Class BatchCancelPipelineJobsRequest (1.12.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class BatchCancelPipelineJobsRequest.

Request message for PipelineService.BatchCancelPipelineJobs.

Generated from protobuf message google.cloud.aiplatform.v1.BatchCancelPipelineJobsRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location}
↳ names array

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

getParent

Required. The name of the PipelineJobs' parent resource.

Format: projects/{project}/locations/{location}

Returns
Type Description
string

setParent

Required. The name of the PipelineJobs' parent resource.

Format: projects/{project}/locations/{location}

Parameter
Name Description
var string
Returns
Type Description
$this

getNames

Required. The names of the PipelineJobs to cancel.

A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setNames

Required. The names of the PipelineJobs to cancel.

A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob}

Parameter
Name Description
var string[]
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The name of the PipelineJobs' parent resource. Format: projects/{project}/locations/{location} Please see PipelineServiceClient::locationName() for help formatting this field.
names string[]

Required. The names of the PipelineJobs to cancel. A maximum of 32 PipelineJobs can be cancelled in a batch. Format: projects/{project}/locations/{location}/pipelineJobs/{pipelineJob} Please see PipelineServiceClient::pipelineJobName() for help formatting this field.
Returns
Type Description
BatchCancelPipelineJobsRequest