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
019package org.apache.hadoop.yarn.api.protocolrecords;
020
021import org.apache.hadoop.classification.InterfaceAudience.Public;
022import org.apache.hadoop.classification.InterfaceStability.Unstable;
023
024/**
025 * <p>
026 * The response from the SharedCacheManager to the client that indicates whether
027 * a requested resource exists in the cache.
028 * </p>
029 */
030@Public
031@Unstable
032public abstract class UseSharedCacheResourceResponse {
033
034  /**
035   * Get the <code>Path</code> corresponding to the requested resource in the
036   * shared cache.
037   *
038   * @return String A <code>Path</code> if the resource exists in the shared
039   *         cache, <code>null</code> otherwise
040   */
041  @Public
042  @Unstable
043  public abstract String getPath();
044
045  /**
046   * Set the <code>Path</code> corresponding to a resource in the shared cache.
047   *
048   * @param p A <code>Path</code> corresponding to a resource in the shared
049   *          cache
050   */
051  @Public
052  @Unstable
053  public abstract void setPath(String p);
054
055}