org.apache.beam.sdk.options.ApplicationNameOptions Maven / Gradle / Ivy

/*
 * 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.beam.sdk.options;

/**
 * Options that allow setting the application name.
 */
public interface ApplicationNameOptions extends PipelineOptions {
  /**
   * Name of application, for display purposes.
   *
   * Defaults to the name of the class that constructs the {@link PipelineOptions}
   * via the {@link PipelineOptionsFactory}.
   */
  @Description("Name of application for display purposes. Defaults to the name of the class that "
      + "constructs the PipelineOptions via the PipelineOptionsFactory.")
  String getAppName();
  void setAppName(String value);
}