Class Task.ExecutionSpec.Builder (1.0.1)

public static final class Task.ExecutionSpec.Builder extends GeneratedMessageV3.Builder<Task.ExecutionSpec.Builder> implements Task.ExecutionSpecOrBuilder

Execution related settings, like retry and service_account.

Protobuf type google.cloud.dataplex.v1.Task.ExecutionSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Task.ExecutionSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

build()

public Task.ExecutionSpec build()
Returns
TypeDescription
Task.ExecutionSpec

buildPartial()

public Task.ExecutionSpec buildPartial()
Returns
TypeDescription
Task.ExecutionSpec

clear()

public Task.ExecutionSpec.Builder clear()
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

clearArgs()

public Task.ExecutionSpec.Builder clearArgs()
Returns
TypeDescription
Task.ExecutionSpec.Builder

clearField(Descriptors.FieldDescriptor field)

public Task.ExecutionSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

clearMaxJobExecutionLifetime()

public Task.ExecutionSpec.Builder clearMaxJobExecutionLifetime()

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
TypeDescription
Task.ExecutionSpec.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Task.ExecutionSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

clearServiceAccount()

public Task.ExecutionSpec.Builder clearServiceAccount()

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
TypeDescription
Task.ExecutionSpec.Builder

This builder for chaining.

clone()

public Task.ExecutionSpec.Builder clone()
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

containsArgs(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getArgs()

public Map<String,String> getArgs()

Use #getArgsMap() instead.

Returns
TypeDescription
Map<String,String>

getArgsCount()

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

Returns
TypeDescription
int

getArgsMap()

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

Returns
TypeDescription
Map<String,String>

getArgsOrDefault(String key, String defaultValue)

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

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getArgsOrThrow(String key)

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

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getDefaultInstanceForType()

public Task.ExecutionSpec getDefaultInstanceForType()
Returns
TypeDescription
Task.ExecutionSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMaxJobExecutionLifetime()

public 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
TypeDescription
Duration

The maxJobExecutionLifetime.

getMaxJobExecutionLifetimeBuilder()

public Duration.Builder getMaxJobExecutionLifetimeBuilder()

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
TypeDescription
Builder

getMaxJobExecutionLifetimeOrBuilder()

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

Returns
TypeDescription
DurationOrBuilder

getMutableArgs()

public Map<String,String> getMutableArgs()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getServiceAccount()

public 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
TypeDescription
String

The serviceAccount.

getServiceAccountBytes()

public 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
TypeDescription
ByteString

The bytes for serviceAccount.

hasMaxJobExecutionLifetime()

public 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
TypeDescription
boolean

Whether the maxJobExecutionLifetime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Task.ExecutionSpec other)

public Task.ExecutionSpec.Builder mergeFrom(Task.ExecutionSpec other)
Parameter
NameDescription
otherTask.ExecutionSpec
Returns
TypeDescription
Task.ExecutionSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Task.ExecutionSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Task.ExecutionSpec.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

mergeMaxJobExecutionLifetime(Duration value)

public Task.ExecutionSpec.Builder mergeMaxJobExecutionLifetime(Duration value)

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

.google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
Task.ExecutionSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Task.ExecutionSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

putAllArgs(Map<String,String> values)

public Task.ExecutionSpec.Builder putAllArgs(Map<String,String> values)

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];

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
Task.ExecutionSpec.Builder

putArgs(String key, String value)

public Task.ExecutionSpec.Builder putArgs(String key, String value)

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];

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
Task.ExecutionSpec.Builder

removeArgs(String key)

public Task.ExecutionSpec.Builder removeArgs(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];

Parameter
NameDescription
keyString
Returns
TypeDescription
Task.ExecutionSpec.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Task.ExecutionSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

setMaxJobExecutionLifetime(Duration value)

public Task.ExecutionSpec.Builder setMaxJobExecutionLifetime(Duration value)

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

.google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
Task.ExecutionSpec.Builder

setMaxJobExecutionLifetime(Duration.Builder builderForValue)

public Task.ExecutionSpec.Builder setMaxJobExecutionLifetime(Duration.Builder builderForValue)

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

.google.protobuf.Duration max_job_execution_lifetime = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Task.ExecutionSpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Task.ExecutionSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

setServiceAccount(String value)

public Task.ExecutionSpec.Builder setServiceAccount(String value)

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];

Parameter
NameDescription
valueString

The serviceAccount to set.

Returns
TypeDescription
Task.ExecutionSpec.Builder

This builder for chaining.

setServiceAccountBytes(ByteString value)

public Task.ExecutionSpec.Builder setServiceAccountBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for serviceAccount to set.

Returns
TypeDescription
Task.ExecutionSpec.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Task.ExecutionSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides