DockerKillCommand.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.hadoop.yarn.server.nodemanager.containermanager.linux.runtime.docker;

/**
 * Encapsulates the docker kill command and its command line arguments.
 */
public class DockerKillCommand extends DockerCommand {
  private static final String KILL_COMMAND = "kill";

  public DockerKillCommand(String containerName) {
    super(KILL_COMMAND);
    super.addCommandArguments("name", containerName);
  }

  /**
   * Set the signal for the {@link DockerKillCommand}.
   *
   * @param signal  the signal to send to the container.
   * @return the {@link DockerKillCommand} with the signal set.
   */
  public DockerKillCommand setSignal(String signal) {
    super.addCommandArguments("signal", signal);
    return this;
  }
}