BatchSaveFederationQueuePoliciesRequest.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 org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.util.Records;

import java.util.List;

/**
 * In Federation mode,
 * we will support batch save queues policies to FederationStateStore.
 */
@Private
@Unstable
public abstract class BatchSaveFederationQueuePoliciesRequest {

  @Private
  @Unstable
  public static BatchSaveFederationQueuePoliciesRequest newInstance(
      List<FederationQueueWeight> federationQueueWeights) {
    BatchSaveFederationQueuePoliciesRequest request =
        Records.newRecord(BatchSaveFederationQueuePoliciesRequest.class);
    request.setFederationQueueWeights(federationQueueWeights);
    return request;
  }

  @Public
  @Unstable
  public abstract List<FederationQueueWeight> getFederationQueueWeights();

  @Private
  @Unstable
  public abstract void setFederationQueueWeights(
      List<FederationQueueWeight> federationQueueWeights);
}