org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse 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.nio.ByteBuffer;
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 start an allocated
* container.
*
*
* @see ContainerManagementProtocol#startContainers(StartContainersRequest)
*/
@Public
@Stable
public abstract class StartContainersResponse {
@Private
@Unstable
public static StartContainersResponse newInstance(
Map servicesMetaData,
List succeededContainers,
Map failedContainers) {
StartContainersResponse response =
Records.newRecord(StartContainersResponse.class);
response.setAllServicesMetaData(servicesMetaData);
response.setSuccessfullyStartedContainers(succeededContainers);
response.setFailedRequests(failedContainers);
return response;
}
/**
* Get the list of ContainerId s of the containers that are
* started successfully.
*
* @return the list of ContainerId s of the containers that are
* started successfully.
* @see ContainerManagementProtocol#startContainers(StartContainersRequest)
*/
@Public
@Stable
public abstract List getSuccessfullyStartedContainers();
@Private
@Unstable
public abstract void setSuccessfullyStartedContainers(
List succeededContainers);
/**
* Get the containerId-to-exception map in which the exception indicates error
* from per container for failed requests
*/
@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 failedContainers);
/**
*
* Get the meta-data from all auxiliary services running on the
* NodeManager.
*
*
* The meta-data is returned as a Map between the auxiliary service names and
* their corresponding per service meta-data as an opaque blob
* ByteBuffer
*
*
*
* To be able to interpret the per-service meta-data, you should consult the
* documentation for the Auxiliary-service configured on the NodeManager
*
*
* @return a Map between the names of auxiliary services and their
* corresponding meta-data
*/
@Public
@Stable
public abstract Map getAllServicesMetaData();
/**
* Set to the list of auxiliary services which have been started on the
* NodeManager. This is done only once when the
* NodeManager starts up
*
* @param allServicesMetaData
* A map from auxiliary service names to the opaque blob
* ByteBuffer for that auxiliary service
*/
@Private
@Unstable
public abstract void setAllServicesMetaData(
Map allServicesMetaData);
}