org.apache.hadoop.classification.InterfaceStability.Stable Java Examples

@Public
@Stable
public static AllocateResponse newInstance(int responseId,
    List<ContainerStatus> completedContainers,
    List<Container> allocatedContainers, List<NodeReport> updatedNodes,
    Resource availResources, AMCommand command, int numClusterNodes,
    PreemptionMessage preempt, List<NMToken> nmTokens,
    List<ContainerResourceIncrease> increasedContainers,
    List<ContainerResourceDecrease> decreasedContainers) {
  AllocateResponse response = newInstance(responseId, completedContainers,
      allocatedContainers, updatedNodes, availResources, command,
      numClusterNodes, preempt, nmTokens);
  response.setIncreasedContainers(increasedContainers);
  response.setDecreasedContainers(decreasedContainers);
  return response;
}
 

@Public
@Stable
public static GetContainerStatusesRequest newInstance(
    List<ContainerId> containerIds) {
  GetContainerStatusesRequest request =
      Records.newRecord(GetContainerStatusesRequest.class);
  request.setContainerIds(containerIds);
  return request;
}
 

@Public
@Stable
public static RefreshServiceAclsRequest newInstance() {
  RefreshServiceAclsRequest request =
      Records.newRecord(RefreshServiceAclsRequest.class);
  return request;
}
 

@Public
@Stable
public static StartContainersRequest newInstance(
    List<StartContainerRequest> requests) {
  StartContainersRequest request =
      Records.newRecord(StartContainersRequest.class);
  request.setStartContainerRequests(requests);
  return request;
}
 

@Public
@Stable
@Idempotent
public RefreshSuperUserGroupsConfigurationResponse 
refreshSuperUserGroupsConfiguration(
    RefreshSuperUserGroupsConfigurationRequest request)
throws StandbyException, YarnException, IOException;
 

@Public
@Stable
public static SubmitApplicationRequest newInstance(
    ApplicationSubmissionContext context) {
  SubmitApplicationRequest request =
      Records.newRecord(SubmitApplicationRequest.class);
  request.setApplicationSubmissionContext(context);
  return request;
}
 

@Public
@Stable
public static RefreshUserToGroupsMappingsRequest newInstance() {
  RefreshUserToGroupsMappingsRequest request =
      Records.newRecord(RefreshUserToGroupsMappingsRequest.class);
  return request;
}
 

@Public
@Stable 
public static GetClusterNodesRequest newInstance() {
  GetClusterNodesRequest request =
      Records.newRecord(GetClusterNodesRequest.class);
  return request;
}
 

@Public
@Stable
public static URL newInstance(String scheme, String host, int port, String file) {
  URL url = Records.newRecord(URL.class);
  url.setScheme(scheme);
  url.setHost(host);
  url.setPort(port);
  url.setFile(file);
  return url;
}
 

/**
 * <p>Set the queue that the application was placed in.<p>
 */
@Public
@Stable
public abstract void setQueue(String queue);
 

/**
 * @return the number of max attempts of the application to be submitted
 */
@Public
@Stable
public abstract int getMaxAppAttempts();
 

@Public
@Stable
public abstract void setRenewer(String renewer);
 

/**
 * @param value true if RM should not manage the AM
 */
@Public
@Stable
public abstract void setUnmanagedAM(boolean value);
 

/**
 * The main api between the ApplicationMaster and the Scheduler.
 * The ApplicationMaster is updating his future resource requirements
 * and may release containers he doens't need.
 * 
 * @param appAttemptId
 * @param ask
 * @param release
 * @param blacklistAdditions 
 * @param blacklistRemovals 
 * @return the {@link Allocation} for the application
 */
@Public
@Stable
Allocation 
allocate(ApplicationAttemptId appAttemptId, 
    List<ResourceRequest> ask,
    List<ContainerId> release, 
    List<String> blacklistAdditions, 
    List<String> blacklistRemovals);
 

/**
 * <p>The interface used by clients to get metrics about the cluster from
 * the <code>ResourceManager</code>.</p>
 * 
 * <p>The <code>ResourceManager</code> responds with a
 * {@link GetClusterMetricsResponse} which includes the 
 * {@link YarnClusterMetrics} with details such as number of current
 * nodes in the cluster.</p>
 * 
 * @param request request for cluster metrics
 * @return cluster metrics
 * @throws YarnException
 * @throws IOException
 */
@Public
@Stable
@Idempotent
public GetClusterMetricsResponse getClusterMetrics(
    GetClusterMetricsRequest request) 
throws YarnException, IOException;
 

/**
 * <p>The interface used by clients to obtain a new {@link ApplicationId} for 
 * submitting new applications.</p>
 * 
 * <p>The <code>ResourceManager</code> responds with a new, monotonically
 * increasing, {@link ApplicationId} which is used by the client to submit
 * a new application.</p>
 *
 * <p>The <code>ResourceManager</code> also responds with details such 
 * as maximum resource capabilities in the cluster as specified in
 * {@link GetNewApplicationResponse}.</p>
 *
 * @param request request to get a new <code>ApplicationId</code>
 * @return response containing the new <code>ApplicationId</code> to be used
 * to submit an application
 * @throws YarnException
 * @throws IOException
 * @see #submitApplication(SubmitApplicationRequest)
 */
@Public
@Stable
@Idempotent
public GetNewApplicationResponse getNewApplication(
    GetNewApplicationRequest request)
throws YarnException, IOException;
 

/**
 * Get the <em>queue</em> to which the application was submitted.
 * @return <em>queue</em> to which the application was submitted
 */
@Public
@Stable
public abstract String getQueue();
 

/**
 * Get the application type
 * 
 * @return the application type
 */
@Public
@Stable
public abstract String getApplicationType();
 

/**
 * Get the <em>name</em> of the queue.
 * @return <em>name</em> of the queue
 */
@Public
@Stable
public abstract String getQueueName();
 

/**
 * Set list of resource-names which should be added to the application blacklist.
 * 
 * @param resourceNames list of resource-names which should be added to the 
 *                  application blacklist
 */
@Public
@Stable
public abstract void setBlacklistAdditions(List<String> resourceNames);
 

/**
 * Get the <em>running applications</em> of the queue.
 * @return <em>running applications</em> of the queue
 */
@Public
@Stable
public abstract List<ApplicationReport> getApplications();
 

/**
 * Get the maximum capability for any {@link Resource} allocated by the 
 * <code>ResourceManager</code> in the cluster.
 * @return maximum capability of allocated resources in the cluster
 */
@Public
@Stable
public abstract Resource getMaximumResourceCapability();
 

/**
 * Get the <code>ContainerId</code> of the container.
 * @return <code>ContainerId</code> of the container
 */
@Public
@Stable
public abstract ContainerId getContainerId();
 

/**
 * Set the number of containers required with the given specifications
 * @param numContainers number of containers required with the given 
 *                      specifications
 */
@Public
@Stable
public abstract void setNumContainers(int numContainers);
 

/**
 * Get the scheme of the URL.
 * @return scheme of the URL
 */
@Public
@Stable
public abstract String getScheme();
 

/**
 * Get the maximum capability for any {@link Resource} allocated by the 
 * <code>ResourceManager</code> in the cluster.
 * @return maximum capability of allocated resources in the cluster
 */
@Public
@Stable
public abstract Resource getMaximumResourceCapability();
 

/**
 * Get the <code>ApplicationId</code> of the application.
 * @return <code>ApplicationId</code> of the application
 */
@Public
@Stable
public abstract ApplicationId getApplicationId();
 

/**
 * Get the <code>YarnApplicationState</code> of the application.
 * @return <code>YarnApplicationState</code> of the application
 */
@Public
@Stable
public abstract YarnApplicationState getYarnApplicationState();
 

/**
 * Get the <em>hostname</em> of the node.
 * @return <em>hostname</em> of the node
 */ 
@Public
@Stable
public abstract String getHost();
 

/**
 * Get the number of <code>NodeManager</code>s in the cluster.
 * @return number of <code>NodeManager</code>s in the cluster
 */
@Public
@Stable
public abstract int getNumNodeManagers();