org.flyte.api.v1.Task 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-2022 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 static java.util.Collections.emptyMap;

/** Super interfaces for all tasks. */
public interface Task {

  /** Specifies task name. */
  String getName();

  /** Specifies the task type identifier. */
  String getType();

  /** Specifies the task interface: inputs/outputs. */
  TypedInterface getInterface();

  /** Specifies custom data about the task. */
  default Struct getCustom() {
    return Struct.of(emptyMap());
  }

  /** Specifies task retry policy. */
  RetryStrategy getRetries();

  /**
   * Indicates whether the system should attempt to lookup this task's output to avoid duplication
   * of work.
   */
  default boolean isCached() {
    return false;
  }

  /** Indicates a logical version to apply to this task for the purpose of cache. */
  default String getCacheVersion() {
    return null;
  }

  /**
   * Indicates whether the system should attempt to execute cached instances in serial to avoid
   * duplicate work.
   */
  default boolean isCacheSerializable() {
    return false;
  }
}