Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ExecutionSpec.
Execution related settings, like retry and service_account.
Generated from protobuf message google.cloud.dataplex.v1.Task.ExecutionSpec
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ args |
array|Google\Protobuf\Internal\MapField
Optional. The arguments to pass to the task. The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders: - ${task_id} - ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument. |
↳ service_account |
string
Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used. |
↳ max_job_execution_lifetime |
Google\Protobuf\Duration
Optional. The maximum duration after which the job execution is expired. |
getArgs
Optional. The arguments to pass to the task.
The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders:
- ${task_id}
- ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.
Generated from protobuf field map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setArgs
Optional. The arguments to pass to the task.
The args can use placeholders of the format ${placeholder} as part of key/value string. These will be interpolated before passing the args to the driver. Currently supported placeholders:
- ${task_id}
- ${job_time} To pass positional args, set the key as TASK_ARGS. The value should be a comma-separated string of all the positional arguments. To use a delimiter other than comma, refer to https://cloud.google.com/sdk/gcloud/reference/topic/escaping. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.
Generated from protobuf field map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getServiceAccount
Required. Service account to use to execute a task.
If not provided, the default Compute service account for the project is used.
Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setServiceAccount
Required. Service account to use to execute a task.
If not provided, the default Compute service account for the project is used.
Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxJobExecutionLifetime
Optional. The maximum duration after which the job execution is expired.
Generated from protobuf field .google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null | |
hasMaxJobExecutionLifetime
clearMaxJobExecutionLifetime
setMaxJobExecutionLifetime
Optional. The maximum duration after which the job execution is expired.
Generated from protobuf field .google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this | |