org.flyte.api.v1.CronSchedule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flytekit-api Show documentation

Java friendly representation of flyteidl protos.

There is a newer version: 0.4.60

/*
 * Copyright 2020-2023 Flyte Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.flyte.api.v1;

import com.google.auto.value.AutoValue;
import javax.annotation.Nullable;

/** Options for schedules to run according to a cron expression. */
@AutoValue
public abstract class CronSchedule {
  /**
   * Standard/default cron implementation as described by
   * https://en.wikipedia.org/wiki/Cron#CRON_expression; Also supports nonstandard predefined
   * scheduling definitions as described by
   * https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
   * except @reboot.
   */
  public abstract String schedule();

  /** ISO 8601 duration as described by https://en.wikipedia.org/wiki/ISO_8601#Durations . */
  @Nullable
  public abstract String offset();

  public static CronSchedule.Builder builder() {
    return new AutoValue_CronSchedule.Builder();
  }

  @AutoValue.Builder
  public abstract static class Builder {

    public abstract CronSchedule.Builder schedule(String schedule);

    public abstract CronSchedule.Builder offset(String offset);

    public abstract CronSchedule build();
  }
}