Interface Task.ExecutionSpecOrBuilder (0.15.0) 

public static interface Task.ExecutionSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsArgs(String key)

public abstract 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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getArgs()

public abstract Map<String,String> getArgs()

Use #getArgsMap() instead.

Returns
Type Description
Map<String,String>

getArgsCount()

public abstract 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;

Returns
Type Description
int

getArgsMap()

public abstract 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;

Returns
Type Description
Map<String,String>

getArgsOrDefault(String key, String defaultValue)

public abstract 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;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getArgsOrThrow(String key)

public abstract 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;

Parameter
Name Description
key String
Returns
Type Description
String

getKmsKey()

public abstract 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;

Returns
Type Description
String

The kmsKey.

getKmsKeyBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for kmsKey.

getMaxJobExecutionLifetime()

public abstract Duration getMaxJobExecutionLifetime()

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

.google.protobuf.Duration max_job_execution_lifetime = 8;

Returns
Type Description
Duration

The maxJobExecutionLifetime.

getMaxJobExecutionLifetimeOrBuilder()

public abstract DurationOrBuilder getMaxJobExecutionLifetimeOrBuilder()

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

.google.protobuf.Duration max_job_execution_lifetime = 8;

Returns
Type Description
DurationOrBuilder

getProject()

public abstract 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 must belong to this project.

string project = 7;

Returns
Type Description
String

The project.

getProjectBytes()

public abstract 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 must belong to this project.

string project = 7;

Returns
Type Description
ByteString

The bytes for project.

getServiceAccount()

public abstract 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;

Returns
Type Description
String

The serviceAccount.

getServiceAccountBytes()

public abstract 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;

Returns
Type Description
ByteString

The bytes for serviceAccount.

hasMaxJobExecutionLifetime()

public abstract boolean hasMaxJobExecutionLifetime()

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

.google.protobuf.Duration max_job_execution_lifetime = 8;

Returns
Type Description
boolean

Whether the maxJobExecutionLifetime field is set.