CheckpointableWatermark.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 gobblin.source.extractor;

import gobblin.annotation.Alpha;


/**
 * {@link Watermark} that is {@link Comparable} and Checkpointable
 */
@Alpha
public interface CheckpointableWatermark extends Watermark, Comparable<CheckpointableWatermark> {

  /**
   *
   * @return the unique id of the source that generated this watermark.
   * Watermarks generated by different sources are not comparable and therefore need to be checkpoint-ed independently
   */
  String getSource();

  /**
   *
   * @return the source-local watermark.
   */
  ComparableWatermark getWatermark();

}