WorkflowInfo.java

/*
 * Copyright © 2016 Cask Data, Inc.
 *
 * 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 co.cask.cdap.api.workflow;

import org.apache.twill.api.RunId;

/**
 * Reveals information about the enclosing workflow to programs running inside that workflow.
 */
public interface WorkflowInfo {

  /**
   * @return the name of the enclosing workflow
   */
  String getName();

  /**
   * @return the node id of the current program within the workflow
   */
  String getNodeId();

  /**
   * @return the run id of the current run of the workflow
   */
  RunId getRunId();
}