path: root/external/flume-sink/src/main/avro/sparkflume.avdl

/**
 * 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.
 */

@namespace("org.apache.spark.streaming.flume.sink")

protocol SparkFlumeProtocol {

  record SparkSinkEvent {
    map<string> headers;
    bytes body;
  }

  record EventBatch {
    string errorMsg = ""; // If this is empty it is a valid message, else it represents an error
    string sequenceNumber;
    array<SparkSinkEvent> events;
  }

  EventBatch getEventBatch (int n);

  void ack (string sequenceNumber);

  void nack (string sequenceNumber);
}