Class: Google::Cloud::Dataplex::V1::Task::ExecutionSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/tasks.rb

Overview

Execution related settings, like retry and service_account.

Defined Under Namespace

Classes: ArgsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#args ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.


229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 229

class ExecutionSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ArgsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kms_key ⇒ ::String

Returns 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}.



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 229

class ExecutionSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ArgsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#max_job_execution_lifetime ⇒ ::Google::Protobuf::Duration

Returns Optional. The maximum duration after which the job execution is expired.

Returns:



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 229

class ExecutionSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ArgsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#project ⇒ ::String

Returns 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.



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 229

class ExecutionSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ArgsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::String

Returns 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.



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'proto_docs/google/cloud/dataplex/v1/tasks.rb', line 229

class ExecutionSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ArgsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end