Class Task.TriggerSpec

  • All Implemented Interfaces:
    Task.TriggerSpecOrBuilder, 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.TriggerSpec
    extends com.google.protobuf.GeneratedMessageV3
    implements Task.TriggerSpecOrBuilder
     Task scheduling and trigger settings.
     
    Protobuf type google.cloud.dataplex.v1.Task.TriggerSpec
    See Also:
    Serialized Form
    • 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()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.TriggerSpec parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

        public static Task.TriggerSpec 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.TriggerSpec parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        public com.google.protobuf.Parser<Task.TriggerSpec> 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.TriggerSpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder