DeleteSubClusterPoliciesConfigurationsRequest.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.federation.store.records;

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;

/**
 * This class is used to respond to queue deletion requests and contains a list of queues.
 */
@Private
@Unstable
public abstract class DeleteSubClusterPoliciesConfigurationsRequest {

  @Private
  @Unstable
  public static DeleteSubClusterPoliciesConfigurationsRequest newInstance(
      List<String> queues) {
    DeleteSubClusterPoliciesConfigurationsRequest request =
        Records.newRecord(DeleteSubClusterPoliciesConfigurationsRequest.class);
    request.setQueues(queues);
    return request;
  }

  /**
   * To obtain the list of queues to be deleted.
   *
   * @return list of queue names.
   */
  @Public
  @Unstable
  public abstract List<String> getQueues();

  /**
   * Set the list of queues to be deleted.
   *
   * @param queues list of queue names.
   */
  @Private
  @Unstable
  public abstract void setQueues(List<String> queues);
}