Package com.google.cloud.dataplex.v1

Interface Task.TriggerSpecOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Task.TriggerSpec, Task.TriggerSpec.Builder
Enclosing class:
Task
public static interface Task.TriggerSpecOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getTypeValue

      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];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      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];
      Returns:
      The type.

    • hasStartTime

      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];
      Returns:
      Whether the startTime field is set.

    • getStartTime

      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];
      Returns:
      The startTime.

    • getStartTimeOrBuilder

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

    • getDisabled

      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];
      Returns:
      The disabled.

    • getMaxRetries

      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];
      Returns:
      The maxRetries.

    • hasSchedule

      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];
      Returns:
      Whether the schedule field is set.

    • getSchedule

      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];
      Returns:
      The schedule.

    • getScheduleBytes

      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];
      Returns:
      The bytes for schedule.

    • getTriggerCase

      Task.TriggerSpec.TriggerCase getTriggerCase()