slider-core/src/main/java/org/apache/slider/common/params/ActionListArgs.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.slider.common.params;

import java.util.HashSet;
import java.util.Set;

import com.beust.jcommander.Parameter;
import com.beust.jcommander.Parameters;

@Parameters(commandNames = {SliderActions.ACTION_LIST},
            commandDescription = SliderActions.DESCRIBE_ACTION_LIST)

public class ActionListArgs extends AbstractActionArgs {
  @Override
  public String getActionName() {
    return SliderActions.ACTION_LIST;
  }

  @Parameter(names = {ARG_LIVE},
          description = "List only live application instances")
  public boolean live;

  @Parameter(names = {ARG_STATE},
      description = "list only applications in the specific YARN state")
  public String state = "";
  
  @Parameter(names = {ARG_VERBOSE},
      description = "print out information in details")
  public boolean verbose = false;

  @Parameter(names = {ARG_CONTAINERS},
      description = "List containers of an application instance")
  public boolean containers;

  @Parameter(names = {ARG_VERSION},
      description = "Filter containers by app version (used with " +
                    ARG_CONTAINERS + ")")
  public String version;

  @Parameter(names = {ARG_COMPONENTS}, variableArity = true,
      description = "Filter containers by component names (used with " +
                    ARG_CONTAINERS + ")")
  public Set<String> components = new HashSet<>(0);;

  /**
   * Get the min #of params expected
   * @return the min number of params in the {@link #parameters} field
   */
  public int getMinParams() {
    return 0;
  }

  @Override
  public int getMaxParams() {
    return 1;
  }
}