public static final class Task.ExecutionSpec extends GeneratedMessageV3 implements Task.ExecutionSpecOrBuilder
Execution related settings, like retry and service_account.
Protobuf type google.cloud.dataplex.v1.Task.ExecutionSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ARGS_FIELD_NUMBER
public static final int ARGS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KMS_KEY_FIELD_NUMBER
public static final int KMS_KEY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MAX_JOB_EXECUTION_LIFETIME_FIELD_NUMBER
public static final int MAX_JOB_EXECUTION_LIFETIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROJECT_FIELD_NUMBER
public static final int PROJECT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Task.ExecutionSpec getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Task.ExecutionSpec.Builder newBuilder()
newBuilder(Task.ExecutionSpec prototype)
public static Task.ExecutionSpec.Builder newBuilder(Task.ExecutionSpec prototype)
public static Task.ExecutionSpec parseDelimitedFrom(InputStream input)
public static Task.ExecutionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Task.ExecutionSpec parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Task.ExecutionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Task.ExecutionSpec parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Task.ExecutionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Task.ExecutionSpec parseFrom(CodedInputStream input)
public static Task.ExecutionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Task.ExecutionSpec parseFrom(InputStream input)
public static Task.ExecutionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Task.ExecutionSpec parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Task.ExecutionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Task.ExecutionSpec> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getArgs()
public Map<String,String> getArgs()
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];
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];
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
|
getDefaultInstanceForType()
public Task.ExecutionSpec getDefaultInstanceForType()
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.
|
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];
getParserForType()
public Parser<Task.ExecutionSpec> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Task.ExecutionSpec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Task.ExecutionSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Task.ExecutionSpec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
