com.streamsets.pipeline.api.Target 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;

/**
 * A Target is a Data Collector destination stage. Destination stages receive records from origin
 * ({@link Source}) or processor ({@link Processor}) stages and write them to an external system.
 *
 * @see Source
 * @see Processor
 */
public interface Target extends Stage {

  /**
   * Target stage context.
   */
  public interface Context extends Stage.Context, ToErrorContext, ToEventContext, ToSourceResponseContext, ProcessedContext {

  }

  /**
   * When running a pipeline, the Data Collector calls this method from the Target stage to write a batch
   * of records to an external system.
   * 
   * @param batch the batch of record to write to the external system.
   * @throws StageException if the Target had an error while writing to the external system.
   */
  public void write(Batch batch) throws StageException;

}