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 tohttps://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, theExecutionSpec.service_accountmust belong to this project.
Optional. The maximum duration after which the job execution is expired.
↳ 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 tohttps://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.
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 tohttps://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.
Required. Service account to use to execute a task.
If not provided, the default Compute service account for the project is
used.
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProject
Optional. The project in which jobs are run. By default, the project
containing the Lake is used. If a project is provided, theExecutionSpec.service_accountmust belong to this project.
Returns
Type
Description
string
setProject
Optional. The project in which jobs are run. By default, the project
containing the Lake is used. If a project is provided, theExecutionSpec.service_accountmust belong to this project.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getMaxJobExecutionLifetime
Optional. The maximum duration after which the job execution is expired.
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}.
Returns
Type
Description
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}.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dataplex V1 Client - Class ExecutionSpec (1.7.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.1 (latest)](/php/docs/reference/cloud-dataplex/latest/V1.Task.ExecutionSpec)\n- [1.7.0](/php/docs/reference/cloud-dataplex/1.7.0/V1.Task.ExecutionSpec)\n- [1.6.1](/php/docs/reference/cloud-dataplex/1.6.1/V1.Task.ExecutionSpec)\n- [1.4.0](/php/docs/reference/cloud-dataplex/1.4.0/V1.Task.ExecutionSpec)\n- [1.3.0](/php/docs/reference/cloud-dataplex/1.3.0/V1.Task.ExecutionSpec)\n- [1.2.1](/php/docs/reference/cloud-dataplex/1.2.1/V1.Task.ExecutionSpec)\n- [1.1.1](/php/docs/reference/cloud-dataplex/1.1.1/V1.Task.ExecutionSpec)\n- [1.0.1](/php/docs/reference/cloud-dataplex/1.0.1/V1.Task.ExecutionSpec)\n- [0.16.1](/php/docs/reference/cloud-dataplex/0.16.1/V1.Task.ExecutionSpec)\n- [0.15.1](/php/docs/reference/cloud-dataplex/0.15.1/V1.Task.ExecutionSpec)\n- [0.14.0](/php/docs/reference/cloud-dataplex/0.14.0/V1.Task.ExecutionSpec)\n- [0.13.0](/php/docs/reference/cloud-dataplex/0.13.0/V1.Task.ExecutionSpec)\n- [0.12.0](/php/docs/reference/cloud-dataplex/0.12.0/V1.Task.ExecutionSpec)\n- [0.11.1](/php/docs/reference/cloud-dataplex/0.11.1/V1.Task.ExecutionSpec)\n- [0.10.0](/php/docs/reference/cloud-dataplex/0.10.0/V1.Task.ExecutionSpec)\n- [0.9.0](/php/docs/reference/cloud-dataplex/0.9.0/V1.Task.ExecutionSpec)\n- [0.8.0](/php/docs/reference/cloud-dataplex/0.8.0/V1.Task.ExecutionSpec)\n- [0.7.0](/php/docs/reference/cloud-dataplex/0.7.0/V1.Task.ExecutionSpec)\n- [0.6.0](/php/docs/reference/cloud-dataplex/0.6.0/V1.Task.ExecutionSpec)\n- [0.5.1](/php/docs/reference/cloud-dataplex/0.5.1/V1.Task.ExecutionSpec)\n- [0.4.0](/php/docs/reference/cloud-dataplex/0.4.0/V1.Task.ExecutionSpec)\n- [0.3.0](/php/docs/reference/cloud-dataplex/0.3.0/V1.Task.ExecutionSpec)\n- [0.2.3](/php/docs/reference/cloud-dataplex/0.2.3/V1.Task.ExecutionSpec)\n- [0.1.6](/php/docs/reference/cloud-dataplex/0.1.6/V1.Task.ExecutionSpec) \nReference documentation and code samples for the Google Cloud Dataplex V1 Client class ExecutionSpec.\n\nExecution related settings, like retry and service_account.\n\nGenerated from protobuf message `google.cloud.dataplex.v1.Task.ExecutionSpec`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Dataplex \\\\ V1 \\\\ Task\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getArgs\n\nOptional. The arguments to pass to the task.\n\nThe args can use placeholders of the format ${placeholder} as\npart of key/value string. These will be interpolated before passing the\nargs to the driver. Currently supported placeholders:\n\n- ${task_id}\n- ${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 \u003chttps://cloud.google.com/sdk/gcloud/reference/topic/escaping\u003e. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.\n\n### setArgs\n\nOptional. The arguments to pass to the task.\n\nThe args can use placeholders of the format ${placeholder} as\npart of key/value string. These will be interpolated before passing the\nargs to the driver. Currently supported placeholders:\n\n- ${task_id}\n- ${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 \u003chttps://cloud.google.com/sdk/gcloud/reference/topic/escaping\u003e. In case of other keys being present in the args, then TASK_ARGS will be passed as the last argument.\n\n### getServiceAccount\n\nRequired. Service account to use to execute a task.\n\nIf not provided, the default Compute service account for the project is\nused.\n\n### setServiceAccount\n\nRequired. Service account to use to execute a task.\n\nIf not provided, the default Compute service account for the project is\nused.\n\n### getProject\n\nOptional. The project in which jobs are run. By default, the project\ncontaining the Lake is used. If a project is provided, the\n[ExecutionSpec.service_account](/php/docs/reference/cloud-dataplex/latest/V1.Task.ExecutionSpec#_Google_Cloud_Dataplex_V1_Task_ExecutionSpec__getServiceAccount__)\nmust belong to this project.\n\n### setProject\n\nOptional. The project in which jobs are run. By default, the project\ncontaining the Lake is used. If a project is provided, the\n[ExecutionSpec.service_account](/php/docs/reference/cloud-dataplex/latest/V1.Task.ExecutionSpec#_Google_Cloud_Dataplex_V1_Task_ExecutionSpec__getServiceAccount__)\nmust belong to this project.\n\n### getMaxJobExecutionLifetime\n\nOptional. The maximum duration after which the job execution is expired.\n\n### hasMaxJobExecutionLifetime\n\n### clearMaxJobExecutionLifetime\n\n### setMaxJobExecutionLifetime\n\nOptional. The maximum duration after which the job execution is expired.\n\n### getKmsKey\n\nOptional. The Cloud KMS key to use for encryption, of the form:\n`projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}`.\n\n### setKmsKey\n\nOptional. The Cloud KMS key to use for encryption, of the form:\n`projects/{project_number}/locations/{location_id}/keyRings/{key-ring-name}/cryptoKeys/{key-name}`."]]
