org.flyte.api.v1.DynamicJobSpec 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 java.util.List;
import java.util.Map;

/** Describes a set of tasks to execute and how the final outputs are produced. */
@AutoValue
public abstract class DynamicJobSpec {

  /**
   * A collection of nodes to execute.
   *
   * @return nodes
   */
  public abstract List nodes();

  // TODO: add minSuccesses from src/main/proto/flyteidl/core/dynamic_job.proto

  /**
   * Describes how to bind the final output of the dynamic job from the outputs of executed nodes.
   * The referenced ids in bindings should have the generated id for the subtask.
   *
   * @return outputs
   */
  public abstract List outputs();

  /**
   * Returns sub-workflows templates.
   *
   * @return sub-workflows.
   */
  public abstract Map subWorkflows();

  /**
   * [Optional] A complete list of task specs referenced in nodes.
   *
   * @return tasks
   */
  public abstract Map tasks();

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

  public abstract Builder toBuilder();

  @AutoValue.Builder
  public abstract static class Builder {
    public abstract Builder nodes(List nodes);

    public abstract Builder outputs(List outputs);

    public abstract Builder subWorkflows(Map subWorkflows);

    public abstract Builder tasks(Map tasks);

    public abstract DynamicJobSpec build();
  }
}