org.apache.reef.webserver.DriverInfoSerializer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reef-webserver Show documentation

HTTP Server component to implement a REST API for the Driver or Evaluators.

The newest version!

/*
 * 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 org.apache.reef.webserver;

import org.apache.reef.tang.annotations.DefaultImplementation;

import java.util.List;

/**
 * Interface for DriverInfoSerializer.
 */
@DefaultImplementation(AvroDriverInfoSerializer.class)
public interface DriverInfoSerializer {
  /**
   * Build AvroDriverInfo object from raw data.
   *
   * @param id
   * @param startTime
   * @return AvroDriverInfo object
   */
  AvroDriverInfo toAvro(final String id, final String startTime, final List services);

  /**
   * Convert AvroDriverInfo object to JSon string.
   *
   * @param avroDriverInfo
   * @return
   */
  String toString(final AvroDriverInfo avroDriverInfo);
}