Google Cloud Life Sciences V2beta Client - Class RunPipelineRequest (0.6.5)

Reference documentation and code samples for the Google Cloud Life Sciences V2beta Client class RunPipelineRequest.

The arguments to the RunPipeline method. The requesting user must have the iam.serviceAccounts.actAs permission for the Cloud Life Sciences service account or the request will fail.

Generated from protobuf message google.cloud.lifesciences.v2beta.RunPipelineRequest

Namespace

Google \ Cloud \ LifeSciences \ V2beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

The project and location that this request should be executed against.

↳ pipeline Google\Cloud\LifeSciences\V2beta\Pipeline

Required. The description of the pipeline to run.

↳ labels array|Google\Protobuf\Internal\MapField

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

↳ pub_sub_topic string

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

getParent

The project and location that this request should be executed against.

Returns
Type Description
string

setParent

The project and location that this request should be executed against.

Parameter
Name Description
var string
Returns
Type Description
$this

getPipeline

Required. The description of the pipeline to run.

Returns
Type Description
Google\Cloud\LifeSciences\V2beta\Pipeline|null

hasPipeline

clearPipeline

setPipeline

Required. The description of the pipeline to run.

Parameter
Name Description
var Google\Cloud\LifeSciences\V2beta\Pipeline
Returns
Type Description
$this

getLabels

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time.

To associate labels with resources created while executing the operation, see the appropriate resource message (for example, VirtualMachine).

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getPubSubTopic

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes.

The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

Returns
Type Description
string

setPubSubTopic

The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes.

The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.

Parameter
Name Description
var string
Returns
Type Description
$this