Reference documentation and code samples for the Google Cloud Life Sciences V2beta Client class Pipeline.
Specifies a series of actions to execute, expressed as Docker containers.
Generated from protobuf message google.cloud.lifesciences.v2beta.Pipeline
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ actions |
array<Google\Cloud\LifeSciences\V2beta\Action>
The list of actions to execute, in the order they are specified. |
↳ resources |
Google\Cloud\LifeSciences\V2beta\Resources
The resources required for execution. |
↳ environment |
array|Google\Protobuf\Internal\MapField
The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value). |
↳ encrypted_environment |
Google\Cloud\LifeSciences\V2beta\Secret
The encrypted environment to pass into every action. Each action can also specify its own encrypted environment. The secret must decrypt to a JSON-encoded dictionary where key-value pairs serve as environment variable names and their values. The decoded environment variables can overwrite the values specified by the |
↳ timeout |
Google\Protobuf\Duration
The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. |
getActions
The list of actions to execute, in the order they are specified.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setActions
The list of actions to execute, in the order they are specified.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\LifeSciences\V2beta\Action>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResources
The resources required for execution.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\LifeSciences\V2beta\Resources|null | |
hasResources
clearResources
setResources
The resources required for execution.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\LifeSciences\V2beta\Resources
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnvironment
The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setEnvironment
The environment to pass into every action. Each action can also specify additional environment variables but cannot delete an entry from this map (though they can overwrite it with a different value).
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEncryptedEnvironment
The encrypted environment to pass into every action. Each action can also specify its own encrypted environment.
The secret must decrypt to a JSON-encoded dictionary where key-value pairs
serve as environment variable names and their values. The decoded
environment variables can overwrite the values specified by the
environment field.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\LifeSciences\V2beta\Secret|null | |
hasEncryptedEnvironment
clearEncryptedEnvironment
setEncryptedEnvironment
The encrypted environment to pass into every action. Each action can also specify its own encrypted environment.
The secret must decrypt to a JSON-encoded dictionary where key-value pairs
serve as environment variable names and their values. The decoded
environment variables can overwrite the values specified by the
environment field.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\LifeSciences\V2beta\Secret
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTimeout
The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED.
If unspecified, it will default to 7 days.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasTimeout
clearTimeout
setTimeout
The maximum amount of time to give the pipeline to complete. This includes the time spent waiting for a worker to be allocated. If the pipeline fails to complete before the timeout, it will be cancelled and the error code will be set to DEADLINE_EXCEEDED.
If unspecified, it will default to 7 days.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |