Class Task.ExecutionSpec (0.16.0)

public static final class Task.ExecutionSpec extends GeneratedMessageV3 implements Task.ExecutionSpecOrBuilder

Execution related settings, like retry and service_account.

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

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()
Returns
Type Description
Task.ExecutionSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Task.ExecutionSpec.Builder newBuilder()
Returns
Type Description
Task.ExecutionSpec.Builder

newBuilder(Task.ExecutionSpec prototype)

public static Task.ExecutionSpec.Builder newBuilder(Task.ExecutionSpec prototype)
Parameter
Name Description
prototype Task.ExecutionSpec
Returns
Type Description
Task.ExecutionSpec.Builder

parseDelimitedFrom(InputStream input)

public static Task.ExecutionSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Task.ExecutionSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task.ExecutionSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task.ExecutionSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Task.ExecutionSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Task.ExecutionSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Task.ExecutionSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Task.ExecutionSpec> parser()
Returns
Type Description
Parser<ExecutionSpec>

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;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArgs()

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;

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;

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;

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;

Parameter
Name Description
key String
Returns
Type Description
String

getDefaultInstanceForType()

public Task.ExecutionSpec getDefaultInstanceForType()
Returns
Type Description
Task.ExecutionSpec

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;

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;

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;

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;

Returns
Type Description
DurationOrBuilder

getParserForType()

public Parser<Task.ExecutionSpec> getParserForType()
Returns
Type Description
Parser<ExecutionSpec>
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;

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;

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;

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;

Returns
Type Description
ByteString

The bytes for serviceAccount.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hasMaxJobExecutionLifetime()

public 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Task.ExecutionSpec.Builder newBuilderForType()
Returns
Type Description
Task.ExecutionSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.ExecutionSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Task.ExecutionSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Task.ExecutionSpec.Builder toBuilder()
Returns
Type Description
Task.ExecutionSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException