hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/api/protocolrecords/ReportNewCollectorInfoRequest.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 org.apache.hadoop.yarn.server.api.protocolrecords;

import java.util.List;
import java.util.Arrays;

import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.Token;
import org.apache.hadoop.yarn.server.api.records.AppCollectorData;
import org.apache.hadoop.yarn.util.Records;

/**
 * Request used to report new collector info from timeline collector manager
 * whenever a collector is launched.
 * The request contains a list of collector data, with each collector data
 * object represented by {@link AppCollectorData}.
 */
@Private
public abstract class ReportNewCollectorInfoRequest {

  public static ReportNewCollectorInfoRequest newInstance(
      List<AppCollectorData> appCollectorsList) {
    ReportNewCollectorInfoRequest request =
        Records.newRecord(ReportNewCollectorInfoRequest.class);
    request.setAppCollectorsList(appCollectorsList);
    return request;
  }

  public static ReportNewCollectorInfoRequest newInstance(
      ApplicationId id, String collectorAddr, Token token) {
    ReportNewCollectorInfoRequest request =
        Records.newRecord(ReportNewCollectorInfoRequest.class);
    request.setAppCollectorsList(
        Arrays.asList(AppCollectorData.newInstance(id, collectorAddr, token)));
    return request;
  }

  public abstract List<AppCollectorData> getAppCollectorsList();

  public abstract void setAppCollectorsList(
      List<AppCollectorData> appCollectorsList);

}