Interface DataplexTaskExecutionSpec
-
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
DataplexTaskExecutionSpec.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)", date="2024-08-31T03:59:20.645Z") @Stability(Stable) public interface DataplexTaskExecutionSpec extends software.amazon.jsii.JsiiSerializable
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classDataplexTaskExecutionSpec.BuilderA builder forDataplexTaskExecutionSpecstatic classDataplexTaskExecutionSpec.Jsii$ProxyAn implementation forDataplexTaskExecutionSpec
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description static DataplexTaskExecutionSpec.Builderbuilder()default Map<String,String>getArgs()The arguments to pass to the task.default StringgetKmsKey()The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{locationId}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.default StringgetMaxJobExecutionLifetime()The maximum duration after which the job execution is expired.default StringgetProject()The project in which jobs are run.StringgetServiceAccount()Service account to use to execute a task.
-
-
-
Method Detail
-
getServiceAccount
@Stability(Stable) @NotNull String getServiceAccount()
Service account to use to execute a task.If not provided, the default Compute service account for the project is used. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#service_account DataplexTask#service_account}
-
getArgs
@Stability(Stable) @Nullable default Map<String,String> getArgs()
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: - ${taskId} - ${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. An object containing a list of 'key': value pairs. Example: { 'name': 'wrench', 'mass': '1.3kg', 'count': '3' }. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#args DataplexTask#args}
-
getKmsKey
@Stability(Stable) @Nullable default String getKmsKey()
The Cloud KMS key to use for encryption, of the form: projects/{project_number}/locations/{locationId}/keyRings/{key-ring-name}/cryptoKeys/{key-name}.Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#kms_key DataplexTask#kms_key}
-
getMaxJobExecutionLifetime
@Stability(Stable) @Nullable default String getMaxJobExecutionLifetime()
The maximum duration after which the job execution is expired.A duration in seconds with up to nine fractional digits, ending with 's'. Example: '3.5s'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#max_job_execution_lifetime DataplexTask#max_job_execution_lifetime}
-
getProject
@Stability(Stable) @Nullable default String getProject()
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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/dataplex_task#project DataplexTask#project}
-
builder
@Stability(Stable) static DataplexTaskExecutionSpec.Builder builder()
- Returns:
- a
DataplexTaskExecutionSpec.BuilderofDataplexTaskExecutionSpec
-
-