Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionSpec

Inherits:

Object

• Object
• Google::Apis::DataplexV1::GoogleCloudDataplexV1TaskExecutionSpec

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/dataplex_v1/classes.rb,
lib/google/apis/dataplex_v1/representations.rb,
lib/google/apis/dataplex_v1/representations.rb

Overview

Execution related settings, like retry and service_account.

Instance Attribute Summary

• #args ⇒ Hash<String,String>

  Optional.

• #kms_key ⇒ String

  Optional.

• #max_job_execution_lifetime ⇒ String

  Optional.

• #project ⇒ String

  Optional.

• #service_account ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDataplexV1TaskExecutionSpec constructor

  A new instance of GoogleCloudDataplexV1TaskExecutionSpec.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1TaskExecutionSpec

Returns a new instance of GoogleCloudDataplexV1TaskExecutionSpec.

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6971

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#args ⇒ Hash<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. Corresponds to the JSON property args

Returns:

• (Hash<String,String>)

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6944

def args
  @args
end

#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. Corresponds to the JSON property kmsKey

Returns:

• (String)

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6951

def kms_key
  @kms_key
end

#max_job_execution_lifetime ⇒ String

Optional. The maximum duration after which the job execution is expired. Corresponds to the JSON property maxJobExecutionLifetime

Returns:

• (String)

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6956

def max_job_execution_lifetime
  @max_job_execution_lifetime
end

#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. Corresponds to the JSON property project

Returns:

• (String)

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6963

def project
  @project
end

#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. Corresponds to the JSON property serviceAccount

Returns:

• (String)

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6969

def service_account
  @service_account
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/dataplex_v1/classes.rb', line 6976

def update!(**args)
  @args = args[:args] if args.key?(:args)
  @kms_key = args[:kms_key] if args.key?(:kms_key)
  @max_job_execution_lifetime = args[:max_job_execution_lifetime] if args.key?(:max_job_execution_lifetime)
  @project = args[:project] if args.key?(:project)
  @service_account = args[:service_account] if args.key?(:service_account)
end