- 1.51.0 (latest)
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.3.0
- 1.2.0
- 1.1.2
- 1.0.1
- 0.2.2
public static final class Task.ExecutionSpec.Builder extends GeneratedMessageV3.Builder<Task.ExecutionSpec.Builder> implements Task.ExecutionSpecOrBuilderExecution related settings, like retry and service_account.
Protobuf type google.cloud.dataplex.v1.Task.ExecutionSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Task.ExecutionSpec.BuilderImplements
Task.ExecutionSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Task.ExecutionSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
build()
public Task.ExecutionSpec build()| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec |
|
buildPartial()
public Task.ExecutionSpec buildPartial()| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec |
|
clear()
public Task.ExecutionSpec.Builder clear()| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
clearArgs()
public Task.ExecutionSpec.Builder clearArgs()| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Task.ExecutionSpec.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
clearKmsKey()
public Task.ExecutionSpec.Builder clearKmsKey() 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 | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
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 | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Task.ExecutionSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
clearProject()
public Task.ExecutionSpec.Builder clearProject()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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
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 | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
clone()
public Task.ExecutionSpec.Builder clone()| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getArgs() (deprecated)
public Map<String,String> getArgs()Use #getArgsMap() instead.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getDefaultInstanceForType()
public Task.ExecutionSpec getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getKmsKey()
public 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 | |
|---|---|
| Type | Description |
String |
The kmsKey. |
getKmsKeyBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for kmsKey. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
DurationOrBuilder |
|
getMutableArgs() (deprecated)
public Map<String,String> getMutableArgs()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getProject()
public 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The project. |
getProjectBytes()
public 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for project. |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the maxJobExecutionLifetime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Task.ExecutionSpec other)
public Task.ExecutionSpec.Builder mergeFrom(Task.ExecutionSpec other)| Parameter | |
|---|---|
| Name | Description |
other |
Task.ExecutionSpec |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Task.ExecutionSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Task.ExecutionSpec.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Task.ExecutionSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
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 | |
|---|---|
| Name | Description |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
value |
String |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Task.ExecutionSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
setKmsKey(String value)
public Task.ExecutionSpec.Builder setKmsKey(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe kmsKey to set. |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
setKmsKeyBytes(ByteString value)
public Task.ExecutionSpec.Builder setKmsKeyBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for kmsKey to set. |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
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 | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
setProject(String value)
public Task.ExecutionSpec.Builder setProject(String value)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe project to set. |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
setProjectBytes(ByteString value)
public Task.ExecutionSpec.Builder setProjectBytes(ByteString value)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 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for project to set. |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Task.ExecutionSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Task.ExecutionSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Task.ExecutionSpec.Builder |
|