org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest 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 org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Stable;
import org.apache.hadoop.yarn.api.ContainerManagementProtocol;
import org.apache.hadoop.yarn.api.records.ContainerLaunchContext;
import org.apache.hadoop.yarn.api.records.NMToken;
import org.apache.hadoop.yarn.api.records.Token;
import org.apache.hadoop.yarn.util.Records;
/**
* The request sent by the ApplicationMaster
to the
* NodeManager
to start a container.
*
* The ApplicationMaster
has to provide details such as
* allocated resource capability, security tokens (if enabled), command
* to be executed to start the container, environment for the process,
* necessary binaries/jar/shared-objects etc. via the
* {@link ContainerLaunchContext}.
*
* @see ContainerManagementProtocol#startContainers(StartContainersRequest)
*/
@Public
@Stable
public abstract class StartContainerRequest {
@Public
@Stable
public static StartContainerRequest newInstance(
ContainerLaunchContext context, Token container) {
StartContainerRequest request =
Records.newRecord(StartContainerRequest.class);
request.setContainerLaunchContext(context);
request.setContainerToken(container);
return request;
}
/**
* Get the ContainerLaunchContext
for the container to be started
* by the NodeManager
.
*
* @return ContainerLaunchContext
for the container to be started
* by the NodeManager
*/
@Public
@Stable
public abstract ContainerLaunchContext getContainerLaunchContext();
/**
* Set the ContainerLaunchContext
for the container to be started
* by the NodeManager
* @param context ContainerLaunchContext
for the container to be
* started by the NodeManager
*/
@Public
@Stable
public abstract void setContainerLaunchContext(ContainerLaunchContext context);
/**
* Get the container token to be used for authorization during starting
* container.
* Note: {@link NMToken} will be used for authenticating communication with
* NodeManager.
* @return the container token to be used for authorization during starting
* container.
* @see NMToken
* @see ContainerManagementProtocol#startContainers(StartContainersRequest)
*/
@Public
@Stable
public abstract Token getContainerToken();
@Public
@Stable
public abstract void setContainerToken(Token container);
}