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.
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.
↳ project
string
Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.
↳ max_job_execution_lifetime
↳ kms_key
string
Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}
.
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.
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.
$this
getServiceAccount
Required. Service account to use to execute a task.
If not provided, the default Compute service account for the project is used.
string
setServiceAccount
Required. Service account to use to execute a task.
If not provided, the default Compute service account for the project is used.
var
string
$this
getProject
Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.
string
setProject
Optional. The project in which jobs are run. By default, the project containing the Lake is used. If a project is provided, the ExecutionSpec.service_account must belong to this project.
var
string
$this
getMaxJobExecutionLifetime
Optional. The maximum duration after which the job execution is expired.
hasMaxJobExecutionLifetime
clearMaxJobExecutionLifetime
setMaxJobExecutionLifetime
Optional. The maximum duration after which the job execution is expired.
$this
getKmsKey
Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}
.
string
setKmsKey
Optional. The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}
.
var
string
$this
