co.cask.tigon.sql.flowlet.InputFlowletConfigurer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tigon-sql Show documentation

There is a newer version: 0.2.1

/*
 * Copyright © 2014 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.tigon.sql.flowlet;

/**
 * Configures InputFlowlet.
 */
public interface InputFlowletConfigurer {

  /**
   * Sets the InputFlowlet Name.
   * @param name Name of the InputFlowlet.
   */
  void setName(String name);

  /**
   * Sets the description of the InputFlowet.
   * @param description Description of the InputFlowlet.
   */
  void setDescription(String description);

  /**
   * Adds a GDAT Input to the InputFlowlet.
   * @param name Name of the Input.
   * @param schema Attach a schema to the Input.
   */
  void addGDATInput(String name, StreamSchema schema);

  /**
   * Adds a JSON Input to the InputFlowlet.
   * @param name Name of the Input.
   * @param schema Attach a schema to the Input.
   */
  void addJSONInput(String name, StreamSchema schema);

  /**
   * Adds a Query query to the InputFlowlet.
   * @param outputName Name of the Query Query (also the name of the output stream).
   * @param sql Query query.
   */
  void addQuery(String outputName, String sql);
}