Google Cloud Ai Platform V1 Client - Class CreatePipelineJobRequest (0.31.0)

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

Request message for PipelineService.CreatePipelineJob.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}`
`↳ pipeline_job`	`Google\Cloud\AIPlatform\V1\PipelineJob` Required. The PipelineJob to create.
`↳ pipeline_job_id`	`string` The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/[a-z][0-9]-/`.

getParent

Required. The resource name of the Location to create the PipelineJob in.

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

Returns
Type	Description
`string`

setParent

Required. The resource name of the Location to create the PipelineJob in.

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPipelineJob

Required. The PipelineJob to create.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\PipelineJob\|null`

hasPipelineJob

clearPipelineJob

setPipelineJob

Required. The PipelineJob to create.

Parameter
Name	Description
`var`	`Google\Cloud\AIPlatform\V1\PipelineJob`

Returns
Type	Description
`$this`

getPipelineJobId

The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.

This value should be less than 128 characters, and valid characters are /[a-z][0-9]-/.

Returns
Type	Description
`string`

setPipelineJobId

The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated.

This value should be less than 128 characters, and valid characters are /[a-z][0-9]-/.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameters
Name	Description
`parent`	`string` Required. The resource name of the Location to create the PipelineJob in. Format: `projects/{project}/locations/{location}` Please see Google\Cloud\AIPlatform\V1\PipelineServiceClient::locationName() for help formatting this field.
`pipelineJob`	`Google\Cloud\AIPlatform\V1\PipelineJob` Required. The PipelineJob to create.
`pipelineJobId`	`string` The ID to use for the PipelineJob, which will become the final component of the PipelineJob name. If not provided, an ID will be automatically generated. This value should be less than 128 characters, and valid characters are `/[a-z][0-9]-/`.

Returns
Type	Description
`Google\Cloud\AIPlatform\V1\CreatePipelineJobRequest`