com.streamsets.pipeline.api.lineage.LineageEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of streamsets-datacollector-api Show documentation
StreamSets Data Collector API
There is a newer version: 6.2.1
Show newest version
/*
 * Copyright 2017 StreamSets 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 com.streamsets.pipeline.api.lineage;

import java.util.List;
import java.util.Map;

public interface LineageEvent {

  /**
   * fetch general parameter - EventType
   * @return EventType
   */
  LineageEventType getEventType();

  /**
   * fetch general parameter - PipelineId
   * @return PipelineId
   */
  String getPipelineId();

  /**
   * fetch general parameter - Permalink
   * @return Permalink
   */
  String getPermalink();

  /**
   * fetch general parameter -  PipelineUser
   * @return PipelineUser
   */
  String getPipelineUser();

  /**
   * fetch general parameter -  PipelineStartTime
   * @return pipelineStartTime
   */
  long getPipelineStartTime();

  /**
   * fetch general parameter - PipelineTitle
   * @return PipelineTitle
   */
  String getPipelineTitle();

  /**
   * fetch general parameter - StageName
   * @return StageName
   */
  String getStageName();

  /**
   * fetch general parameter - event timestamp
   * @return event timestamp
   */
  long getTimeStamp();

  /**
   * fetch general parameter - DataCollectorId
   * @return DataCollectorId
   */
  String getPipelineDataCollectorId();

  /**
   * Add a specificAttribute to the LineageEvent.
   * @param name - Attribute's name.
   * @param value - Attribute's value.
   */
  void setSpecificAttribute(LineageSpecificAttribute name, String value);

  /**
   * Getter for a specificAttribute.
   * @return attribute
   */
  String getSpecificAttribute(LineageSpecificAttribute name);

  /**
   * Sets the tag array.
   * @param tags
   */
  void setTags(List tags);

  /**
   * Retrieves the tags.
   * @return
   */
  List getTags();

  /**
   * Sets the properties.
   *
   * @param properties
   */
  void setProperties(Map properties);

  /**
   * Gets the extended properties list.
   *
   * @return extended properties list.
   */
  Map getExtendedProperties();

  /**
   * Sets the extended properties.
   *
   * @param properties
   */
  void setExtendedProperties(Map properties);

  /**
   * Gets the properties map.
   *
   * @return properties map.
   */
  Map getProperties();


  /**
   * Provides a list of all the specific attributes associated with this Lineage Event type which are not set.
   * @return list of all specific attributes which are not set.
   */
  List missingSpecificAttributes();

  /**
   * return formatted String containing LineageEvent data.
   *
   * @return printable LineageEvent
   */
  String toString();

}