Package com.google.cloud.dataplex.v1

Class Task.ExecutionSpec

  • All Implemented Interfaces:
    Task.ExecutionSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Task
    public static final class Task.ExecutionSpec
extends com.google.protobuf.GeneratedMessageV3
implements Task.ExecutionSpecOrBuilder
     Execution related settings, like retry and service_account.
    Protobuf type google.cloud.dataplex.v1.Task.ExecutionSpec
    See Also:
    Serialized Form

    • Field Detail

      • SERVICE_ACCOUNT_FIELD_NUMBER

        public static final int SERVICE_ACCOUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MAX_JOB_EXECUTION_LIFETIME_FIELD_NUMBER

        public static final int MAX_JOB_EXECUTION_LIFETIME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getArgsCount

        public int getArgsCount()
        Description copied from interface: Task.ExecutionSpecOrBuilder
         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];
        Specified by:
        getArgsCount in interface Task.ExecutionSpecOrBuilder

      • containsArgs

        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];
        Specified by:
        containsArgs in interface Task.ExecutionSpecOrBuilder

      • 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];
        Specified by:
        getArgsMap in interface Task.ExecutionSpecOrBuilder

      • getArgsOrDefault

        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];
        Specified by:
        getArgsOrDefault in interface Task.ExecutionSpecOrBuilder

      • getArgsOrThrow

        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];
        Specified by:
        getArgsOrThrow in interface Task.ExecutionSpecOrBuilder

      • 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];
        Specified by:
        getServiceAccount in interface Task.ExecutionSpecOrBuilder
        Returns:
        The serviceAccount.

      • getServiceAccountBytes

        public com.google.protobuf.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];
        Specified by:
        getServiceAccountBytes in interface Task.ExecutionSpecOrBuilder
        Returns:
        The bytes for serviceAccount.

      • 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][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account]
 must belong to this project.
        string project = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getProject in interface Task.ExecutionSpecOrBuilder
        Returns:
        The project.

      • getProjectBytes

        public com.google.protobuf.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][google.cloud.dataplex.v1.Task.ExecutionSpec.service_account]
 must belong to this project.
        string project = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getProjectBytes in interface Task.ExecutionSpecOrBuilder
        Returns:
        The bytes for project.

      • 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];
        Specified by:
        hasMaxJobExecutionLifetime in interface Task.ExecutionSpecOrBuilder
        Returns:
        Whether the maxJobExecutionLifetime field is set.

      • getMaxJobExecutionLifetime

        public com.google.protobuf.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];
        Specified by:
        getMaxJobExecutionLifetime in interface Task.ExecutionSpecOrBuilder
        Returns:
        The maxJobExecutionLifetime.

      • getMaxJobExecutionLifetimeOrBuilder

        public com.google.protobuf.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];
        Specified by:
        getMaxJobExecutionLifetimeOrBuilder in interface Task.ExecutionSpecOrBuilder

      • 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];
        Specified by:
        getKmsKey in interface Task.ExecutionSpecOrBuilder
        Returns:
        The kmsKey.

      • getKmsKeyBytes

        public com.google.protobuf.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];
        Specified by:
        getKmsKeyBytes in interface Task.ExecutionSpecOrBuilder
        Returns:
        The bytes for kmsKey.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Task.ExecutionSpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Task.ExecutionSpec.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Task.ExecutionSpec.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Task.ExecutionSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<Task.ExecutionSpec> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Task.ExecutionSpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder