org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse 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.hadoop.yarn.api.protocolrecords;
import java.util.List;
import java.util.Map;
import org.apache.hadoop.classification.InterfaceAudience.Private;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.api.ContainerManagementProtocol;
import org.apache.hadoop.yarn.api.records.ContainerId;
import org.apache.hadoop.yarn.api.records.SerializedException;
import org.apache.hadoop.yarn.util.Records;
/**
*
* The response sent by the NodeManager
to the
* ApplicationMaster
when asked to stop allocated
* containers.
*
*
* @see ContainerManagementProtocol#stopContainers(StopContainersRequest)
*/
@Public
@Stable
public abstract class StopContainersResponse {
@Private
@Unstable
public static StopContainersResponse newInstance(
List succeededRequests,
Map failedRequests) {
StopContainersResponse response =
Records.newRecord(StopContainersResponse.class);
response.setFailedRequests(failedRequests);
response.setSuccessfullyStoppedContainers(succeededRequests);
return response;
}
/**
* Get the list of containerIds of successfully stopped containers.
*
* @return the list of containerIds of successfully stopped containers.
*/
@Public
@Stable
public abstract List getSuccessfullyStoppedContainers();
/**
* Set the list of containerIds of successfully stopped containers.
*/
@Private
@Unstable
public abstract void setSuccessfullyStoppedContainers(
List succeededRequests);
/**
* Get the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
* @return map of containerId-to-exception
*/
@Public
@Stable
public abstract Map getFailedRequests();
/**
* Set the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
*/
@Private
@Unstable
public abstract void setFailedRequests(
Map failedRequests);
}