hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-common/src/main/java/org/apache/hadoop/yarn/server/federation/store/records/GetSubClusterPoliciesConfigurationsResponse.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 java.util.List;

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;

/**
 * GetSubClusterPolicyConfigurationResponse contains the answer from the {@code
 * FederationPolicyStore} to a request to get all the policies configured in the
 * system via a {@link SubClusterPolicyConfiguration}.
 */
@Private
@Unstable
public abstract class GetSubClusterPoliciesConfigurationsResponse {

  @Private
  @Unstable
  public static GetSubClusterPoliciesConfigurationsResponse newInstance(
      List<SubClusterPolicyConfiguration> policyConfigurations) {
    GetSubClusterPoliciesConfigurationsResponse response =
        Records.newRecord(GetSubClusterPoliciesConfigurationsResponse.class);
    response.setPoliciesConfigs(policyConfigurations);
    return response;
  }

  /**
   * Get all the policies configured in the system.
   *
   * @return all the policies configured in the system
   */
  @Public
  @Unstable
  public abstract List<SubClusterPolicyConfiguration> getPoliciesConfigs();

  /**
   * Sets all the policies configured in the system.
   *
   * @param policyConfigurations all the policies configured in the system
   */
  @Private
  @Unstable
  public abstract void setPoliciesConfigs(
      List<SubClusterPolicyConfiguration> policyConfigurations);

}