Class Task.ExecutionSpec (1.17.0)

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

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
TypeDescription
int

KMS_KEY_FIELD_NUMBER

public static final int KMS_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_JOB_EXECUTION_LIFETIME_FIELD_NUMBER

public static final int MAX_JOB_EXECUTION_LIFETIME_FIELD_NUMBER
Field Value
TypeDescription
int

PROJECT_FIELD_NUMBER

public static final int PROJECT_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Task.ExecutionSpec getDefaultInstance()
Returns
TypeDescription
Task.ExecutionSpec

getDescriptor()

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

newBuilder()

public static Task.ExecutionSpec.Builder newBuilder()
Returns
TypeDescription
Task.ExecutionSpec.Builder

newBuilder(Task.ExecutionSpec prototype)

public static Task.ExecutionSpec.Builder newBuilder(Task.ExecutionSpec prototype)
Parameter
NameDescription
prototypeTask.ExecutionSpec
Returns
TypeDescription
Task.ExecutionSpec.Builder

parseDelimitedFrom(InputStream input)

public static Task.ExecutionSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Task.ExecutionSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task.ExecutionSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task.ExecutionSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Task.ExecutionSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Task.ExecutionSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task.ExecutionSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.ExecutionSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Task.ExecutionSpec> parser()
Returns
TypeDescription
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 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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

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

Returns
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<Task.ExecutionSpec> getParserForType()
Returns
TypeDescription
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 [(.google.api.field_behavior) = OPTIONAL];

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

The bytes for project.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.ExecutionSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Task.ExecutionSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException