/*
 * 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.flink.runtime.webmonitor.handlers;

import org.apache.flink.runtime.rest.messages.MessageParameter;

/**
 * Query parameter specifying one or more arguments for the program.
 *
 * @see org.apache.flink.client.program.PackagedProgram.Builder#setArguments(String...)
 */
public class ProgramArgQueryParameter extends StringQueryParameter {
    static final String PROGRAM_ARG_PARAMETER_NAME = "programArg";

    public ProgramArgQueryParameter() {
        super(PROGRAM_ARG_PARAMETER_NAME, MessageParameter.MessageParameterRequisiteness.OPTIONAL);
    }

    @Override
    public String getDescription() {
        return "Comma-separated list of program arguments.";
    }
}
