001    /**
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *     http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing, software
013     * distributed under the License is distributed on an "AS IS" BASIS,
014     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015     * See the License for the specific language governing permissions and
016     * limitations under the License.
017     */
018    
019    package org.apache.hadoop.yarn.api.protocolrecords;
020    
021    import org.apache.hadoop.classification.InterfaceAudience.Private;
022    import org.apache.hadoop.classification.InterfaceAudience.Public;
023    import org.apache.hadoop.classification.InterfaceStability.Unstable;
024    import org.apache.hadoop.yarn.api.records.ReservationDefinition;
025    import org.apache.hadoop.yarn.util.Records;
026    
027    /**
028     * {@link ReservationUpdateResponse} contains the answer of the admission
029     * control system in the {@code ResourceManager} to a reservation update
030     * operation. Currently response is empty if the operation was successful, if
031     * not an exception reporting reason for a failure.
032     * 
033     * @see ReservationDefinition
034     * 
035     */
036    @Public
037    @Unstable
038    public abstract class ReservationUpdateResponse {
039    
040      @Private
041      @Unstable
042      public static ReservationUpdateResponse newInstance() {
043        ReservationUpdateResponse response =
044            Records.newRecord(ReservationUpdateResponse.class);
045        return response;
046      }
047    
048    }