Package com.google.cloud.dataplex.v1

Interface Task.ExecutionSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Task.ExecutionSpec, Task.ExecutionSpec.Builder
Enclosing class:
Task
public static interface Task.ExecutionSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getArgsCount

      int getArgsCount()
       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.
      map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];

    • containsArgs

      boolean containsArgs(String key)
       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.
      map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getArgs

      @Deprecated Map<String,String> getArgs()
      Deprecated.
      Use getArgsMap() instead.

    • getArgsMap

      Map<String,String> getArgsMap()
       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.
      map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getArgsOrDefault

      String getArgsOrDefault(String key, String defaultValue)
       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.
      map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getArgsOrThrow

      String getArgsOrThrow(String key)
       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.
      map<string, string> args = 4 [(.google.api.field_behavior) = OPTIONAL];

    • getServiceAccount

      String getServiceAccount()
       Required. Service account to use to execute a task.
 If not provided, the default Compute service account for the project is
 used.
      string service_account = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      com.google.protobuf.ByteString getServiceAccountBytes()
       Required. Service account to use to execute a task.
 If not provided, the default Compute service account for the project is
 used.
      string service_account = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for serviceAccount.

    • getProject

      String getProject()
       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][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account]
 must belong to this project.
      string project = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The project.

    • getProjectBytes

      com.google.protobuf.ByteString getProjectBytes()
       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][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account]
 must belong to this project.
      string project = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for project.

    • hasMaxJobExecutionLifetime

      boolean hasMaxJobExecutionLifetime()
       Optional. The maximum duration after which the job execution is expired.
      .google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the maxJobExecutionLifetime field is set.

    • getMaxJobExecutionLifetime

      com.google.protobuf.Duration getMaxJobExecutionLifetime()
       Optional. The maximum duration after which the job execution is expired.
      .google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The maxJobExecutionLifetime.

    • getMaxJobExecutionLifetimeOrBuilder

      com.google.protobuf.DurationOrBuilder getMaxJobExecutionLifetimeOrBuilder()
       Optional. The maximum duration after which the job execution is expired.
      .google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getKmsKey

      String getKmsKey()
       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}`.
      string kms_key = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The kmsKey.

    • getKmsKeyBytes

      com.google.protobuf.ByteString getKmsKeyBytes()
       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}`.
      string kms_key = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for kmsKey.