org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest 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.Map;
import org.apache.hadoop.classification.InterfaceAudience.Public;
import org.apache.hadoop.classification.InterfaceStability.Unstable;
import org.apache.hadoop.yarn.api.records.ApplicationId;
import org.apache.hadoop.yarn.api.records.ApplicationTimeoutType;
import org.apache.hadoop.yarn.util.Records;
/**
*
* The request sent by the client to the ResourceManager to set or
* update the application timeout.
*
*
* The request includes the {@link ApplicationId} of the application and timeout
* to be set for an application
*
*/
@Public
@Unstable
public abstract class UpdateApplicationTimeoutsRequest {
public static UpdateApplicationTimeoutsRequest newInstance(
ApplicationId applicationId,
Map applicationTimeouts) {
UpdateApplicationTimeoutsRequest request =
Records.newRecord(UpdateApplicationTimeoutsRequest.class);
request.setApplicationId(applicationId);
request.setApplicationTimeouts(applicationTimeouts);
return request;
}
/**
* Get the ApplicationId of the application.
* @return ApplicationId of the application
*/
public abstract ApplicationId getApplicationId();
/**
* Set the ApplicationId of the application.
* @param applicationId ApplicationId of the application
*/
public abstract void setApplicationId(ApplicationId applicationId);
/**
* Get ApplicationTimeouts of the application. Timeout value is
* in ISO8601 standard with format yyyy-MM-dd'T'HH:mm:ss.SSSZ.
* @return all ApplicationTimeouts of the application.
*/
public abstract Map getApplicationTimeouts();
/**
* Set the ApplicationTimeouts for the application. Timeout value
* is absolute. Timeout value should meet ISO8601 format. Support ISO8601
* format is yyyy-MM-dd'T'HH:mm:ss.SSSZ. All pre-existing Map entries
* are cleared before adding the new Map.
* @param applicationTimeouts ApplicationTimeoutss for the
* application
*/
public abstract void setApplicationTimeouts(
Map applicationTimeouts);
}