org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse 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.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.ApplicationMasterProtocol;
import org.apache.hadoop.yarn.api.records.ApplicationAccessType;
import org.apache.hadoop.yarn.api.records.Resource;
import org.apache.hadoop.yarn.util.Records;
/**
* The response sent by the ResourceManager to a new
* ApplicationMaster on registration.
*
* The response contains critical details such as:
*
* - Maximum capability for allocated resources in the cluster.
* ApplicationACLs for the application.- ClientToAMToken master key.
*
*
*
* @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)
*/
@Public
@Stable
public abstract class RegisterApplicationMasterResponse {
@Private
@Unstable
public static RegisterApplicationMasterResponse newInstance(
Resource minCapability, Resource maxCapability,
Map acls, ByteBuffer key,
String queue) {
RegisterApplicationMasterResponse response =
Records.newRecord(RegisterApplicationMasterResponse.class);
response.setMaximumResourceCapability(maxCapability);
response.setApplicationACLs(acls);
response.setClientToAMTokenMasterKey(key);
response.setQueue(queue);
return response;
}
/**
* Get the maximum capability for any {@link Resource} allocated by the
* ResourceManager in the cluster.
* @return maximum capability of allocated resources in the cluster
*/
@Public
@Stable
public abstract Resource getMaximumResourceCapability();
@Private
@Unstable
public abstract void setMaximumResourceCapability(Resource capability);
/**
* Get the ApplicationACLs for the application.
* @return all the ApplicationACLs
*/
@Public
@Stable
public abstract Map getApplicationACLs();
/**
* Set the ApplicationACLs for the application.
* @param acls
*/
@Private
@Unstable
public abstract void setApplicationACLs(Map acls);
/**
* Get ClientToAMToken master key.
* The ClientToAMToken master key is sent to ApplicationMaster
* by ResourceManager via {@link RegisterApplicationMasterResponse}
* , used to verify corresponding ClientToAMToken.
*/
@Public
@Stable
public abstract ByteBuffer getClientToAMTokenMasterKey();
/**
* Set ClientToAMToken master key.
*/
@Public
@Stable
public abstract void setClientToAMTokenMasterKey(ByteBuffer key);
/**
* Get the queue that the application was placed in.
*/
@Public
@Stable
public abstract String getQueue();
/**
*
Set the queue that the application was placed in.
*/
@Public
@Stable
public abstract void setQueue(String queue);
}