Source code

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,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.apache.reef.runtime.yarn.client;
020
021import org.apache.reef.annotations.audience.ClientSide;
022import org.apache.reef.annotations.audience.Public;
023import org.apache.reef.runtime.yarn.driver.parameters.JobSubmissionDirectoryPrefix;
024import org.apache.reef.runtime.yarn.client.parameters.JobQueue;
025import org.apache.reef.tang.formats.ConfigurationModule;
026import org.apache.reef.tang.formats.ConfigurationModuleBuilder;
027import org.apache.reef.tang.formats.OptionalParameter;
028
029/**
030 * Additional YARN-Specific configuration options to be merged with DriverConfiguration.
031 */
032@Public
033@ClientSide
034public final class YarnDriverConfiguration extends ConfigurationModuleBuilder {
035
036  /**
037   * The queue to submit this Driver to.
038   */
039  public static final OptionalParameter<String> QUEUE = new OptionalParameter<>();
040  
041  /**
042   * The job submission directory.
043   */
044  public static final OptionalParameter<String> JOB_SUBMISSION_DIRECTORY_PREFIX = new OptionalParameter<>();
045
046  /**
047   * ConfigurationModule to set YARN-Specific configuration options to be merged with DriverConfiguration.
048   */
049  public static final ConfigurationModule CONF = new YarnDriverConfiguration()
050      .bindNamedParameter(JobQueue.class, QUEUE)
051      .bindNamedParameter(JobSubmissionDirectoryPrefix.class, JOB_SUBMISSION_DIRECTORY_PREFIX)
052      .build();
053}