Class Task.TriggerSpec.Builder

  • All Implemented Interfaces:
    Task.TriggerSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Task.TriggerSpec

    public static final class Task.TriggerSpec.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
    implements Task.TriggerSpecOrBuilder
     Task scheduling and trigger settings.
     
    Protobuf type google.cloud.dataplex.v1.Task.TriggerSpec
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • clear

        public Task.TriggerSpec.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • getDefaultInstanceForType

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

        public Task.TriggerSpec build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public Task.TriggerSpec buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • clone

        public Task.TriggerSpec.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • setField

        public Task.TriggerSpec.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • clearField

        public Task.TriggerSpec.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • clearOneof

        public Task.TriggerSpec.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • setRepeatedField

        public Task.TriggerSpec.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • addRepeatedField

        public Task.TriggerSpec.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • mergeFrom

        public Task.TriggerSpec.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Task.TriggerSpec.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • mergeFrom

        public Task.TriggerSpec.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Task.TriggerSpec.Builder>
        Throws:
        IOException
      • getTypeValue

        public int getTypeValue()
         Required. Immutable. Trigger type of the user-specified Task.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getTypeValue in interface Task.TriggerSpecOrBuilder
        Returns:
        The enum numeric value on the wire for type.
      • setTypeValue

        public Task.TriggerSpec.Builder setTypeValue​(int value)
         Required. Immutable. Trigger type of the user-specified Task.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The enum numeric value on the wire for type to set.
        Returns:
        This builder for chaining.
      • getType

        public Task.TriggerSpec.Type getType()
         Required. Immutable. Trigger type of the user-specified Task.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getType in interface Task.TriggerSpecOrBuilder
        Returns:
        The type.
      • setType

        public Task.TriggerSpec.Builder setType​(Task.TriggerSpec.Type value)
         Required. Immutable. Trigger type of the user-specified Task.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.
      • clearType

        public Task.TriggerSpec.Builder clearType()
         Required. Immutable. Trigger type of the user-specified Task.
         
        .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.
      • hasStartTime

        public boolean hasStartTime()
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasStartTime in interface Task.TriggerSpecOrBuilder
        Returns:
        Whether the startTime field is set.
      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getStartTime in interface Task.TriggerSpecOrBuilder
        Returns:
        The startTime.
      • setStartTime

        public Task.TriggerSpec.Builder setStartTime​(com.google.protobuf.Timestamp value)
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      • setStartTime

        public Task.TriggerSpec.Builder setStartTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      • mergeStartTime

        public Task.TriggerSpec.Builder mergeStartTime​(com.google.protobuf.Timestamp value)
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      • clearStartTime

        public Task.TriggerSpec.Builder clearStartTime()
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      • getStartTimeBuilder

        public com.google.protobuf.Timestamp.Builder getStartTimeBuilder()
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Optional. The first run of the task will be after this time.
         If not specified, the task will run shortly after being submitted if
         ON_DEMAND and based on the schedule if RECURRING.
         
        .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getStartTimeOrBuilder in interface Task.TriggerSpecOrBuilder
      • getDisabled

        public boolean getDisabled()
         Optional. Prevent the task from executing.
         This does not cancel already running tasks. It is intended to temporarily
         disable RECURRING tasks.
         
        bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisabled in interface Task.TriggerSpecOrBuilder
        Returns:
        The disabled.
      • setDisabled

        public Task.TriggerSpec.Builder setDisabled​(boolean value)
         Optional. Prevent the task from executing.
         This does not cancel already running tasks. It is intended to temporarily
         disable RECURRING tasks.
         
        bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The disabled to set.
        Returns:
        This builder for chaining.
      • clearDisabled

        public Task.TriggerSpec.Builder clearDisabled()
         Optional. Prevent the task from executing.
         This does not cancel already running tasks. It is intended to temporarily
         disable RECURRING tasks.
         
        bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • getMaxRetries

        public int getMaxRetries()
         Optional. Number of retry attempts before aborting.
         Set to zero to never attempt to retry a failed task.
         
        int32 max_retries = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMaxRetries in interface Task.TriggerSpecOrBuilder
        Returns:
        The maxRetries.
      • setMaxRetries

        public Task.TriggerSpec.Builder setMaxRetries​(int value)
         Optional. Number of retry attempts before aborting.
         Set to zero to never attempt to retry a failed task.
         
        int32 max_retries = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The maxRetries to set.
        Returns:
        This builder for chaining.
      • clearMaxRetries

        public Task.TriggerSpec.Builder clearMaxRetries()
         Optional. Number of retry attempts before aborting.
         Set to zero to never attempt to retry a failed task.
         
        int32 max_retries = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • hasSchedule

        public boolean hasSchedule()
         Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
         running tasks periodically. To explicitly set a timezone to the cron
         tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
         "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
         string from IANA time zone database. For example,
         `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
         *`. This field is required for RECURRING tasks.
         
        string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasSchedule in interface Task.TriggerSpecOrBuilder
        Returns:
        Whether the schedule field is set.
      • getSchedule

        public String getSchedule()
         Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
         running tasks periodically. To explicitly set a timezone to the cron
         tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
         "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
         string from IANA time zone database. For example,
         `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
         *`. This field is required for RECURRING tasks.
         
        string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSchedule in interface Task.TriggerSpecOrBuilder
        Returns:
        The schedule.
      • getScheduleBytes

        public com.google.protobuf.ByteString getScheduleBytes()
         Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
         running tasks periodically. To explicitly set a timezone to the cron
         tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
         "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
         string from IANA time zone database. For example,
         `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
         *`. This field is required for RECURRING tasks.
         
        string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getScheduleBytes in interface Task.TriggerSpecOrBuilder
        Returns:
        The bytes for schedule.
      • setSchedule

        public Task.TriggerSpec.Builder setSchedule​(String value)
         Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
         running tasks periodically. To explicitly set a timezone to the cron
         tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
         "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
         string from IANA time zone database. For example,
         `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
         *`. This field is required for RECURRING tasks.
         
        string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The schedule to set.
        Returns:
        This builder for chaining.
      • clearSchedule

        public Task.TriggerSpec.Builder clearSchedule()
         Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
         running tasks periodically. To explicitly set a timezone to the cron
         tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
         "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
         string from IANA time zone database. For example,
         `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
         *`. This field is required for RECURRING tasks.
         
        string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.
      • setScheduleBytes

        public Task.TriggerSpec.Builder setScheduleBytes​(com.google.protobuf.ByteString value)
         Optional. Cron schedule (https://en.wikipedia.org/wiki/Cron) for
         running tasks periodically. To explicitly set a timezone to the cron
         tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
         "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
         string from IANA time zone database. For example,
         `CRON_TZ=America/New_York 1 * * * *`, or `TZ=America/New_York 1 * * *
         *`. This field is required for RECURRING tasks.
         
        string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for schedule to set.
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final Task.TriggerSpec.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>
      • mergeUnknownFields

        public final Task.TriggerSpec.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Task.TriggerSpec.Builder>