Dataplex V1 API - Class Google::Cloud::Dataplex::V1::Task::ExecutionSpec (v0.6.1)

Version 0.6.1

• 1.0.1 (latest)
• 1.0.0
• 0.23.0
• 0.22.0
• 0.21.1
• 0.20.0
• 0.19.0
• 0.18.2
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.1
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.1
• 0.5.1
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.0

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::Task::ExecutionSpec.

Execution related settings, like retry and service_account.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#args

def args() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) —

  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.

#args=

def args=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) —

  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.

Returns

• (::Google::Protobuf::Map{::String => ::String}) —

  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.

#kms_key

def kms_key() -> ::String

Returns

• (::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}.

#kms_key=

def kms_key=(value) -> ::String

Parameter

• value (::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}.

Returns

• (::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}.

#max_job_execution_lifetime

def max_job_execution_lifetime() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Optional. The maximum duration after which the job execution is expired.

#max_job_execution_lifetime=

def max_job_execution_lifetime=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Optional. The maximum duration after which the job execution is expired.

Returns

• (::Google::Protobuf::Duration) — Optional. The maximum duration after which the job execution is expired.

#project

def project() -> ::String

Returns

• (::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.

#project=

def project=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#service_account

def service_account() -> ::String

Returns

• (::String) — Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used.

#service_account=

def service_account=(value) -> ::String

Parameter

• value (::String) — Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used.

Returns

• (::String) — Required. Service account to use to execute a task. If not provided, the default Compute service account for the project is used.