org.apache.hadoop.mapred.JobID Maven / Gradle / Ivy
Show all versions of hadoop-apache Show documentation
/**
* 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.mapred;
import java.io.DataInput;
import java.io.IOException;
import org.apache.hadoop.classification.InterfaceAudience;
import org.apache.hadoop.classification.InterfaceStability;
/**
* JobID represents the immutable and unique identifier for
* the job. JobID consists of two parts. First part
* represents the jobtracker identifier, so that jobID to jobtracker map
* is defined. For cluster setup this string is the jobtracker
* start time, for local setting, it is "local".
* Second part of the JobID is the job number.
* An example JobID is :
* job_200707121733_0003 , which represents the third job
* running at the jobtracker started at 200707121733.
*
* Applications should never construct or parse JobID strings, but rather
* use appropriate constructors or {@link #forName(String)} method.
*
* @see TaskID
* @see TaskAttemptID
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public class JobID extends org.apache.hadoop.mapreduce.JobID {
/**
* Constructs a JobID object
* @param jtIdentifier jobTracker identifier
* @param id job number
*/
public JobID(String jtIdentifier, int id) {
super(jtIdentifier, id);
}
public JobID() { }
/**
* Downgrade a new JobID to an old one
* @param old a new or old JobID
* @return either old or a new JobID build to match old
*/
public static JobID downgrade(org.apache.hadoop.mapreduce.JobID old) {
if (old instanceof JobID) {
return (JobID) old;
} else {
return new JobID(old.getJtIdentifier(), old.getId());
}
}
@Deprecated
public static JobID read(DataInput in) throws IOException {
JobID jobId = new JobID();
jobId.readFields(in);
return jobId;
}
/** Construct a JobId object from given string
* @return constructed JobId object or null if the given String is null
* @throws IllegalArgumentException if the given string is malformed
*/
public static JobID forName(String str) throws IllegalArgumentException {
return (JobID) org.apache.hadoop.mapreduce.JobID.forName(str);
}
/**
* Returns a regex pattern which matches task IDs. Arguments can
* be given null, in which case that part of the regex will be generic.
* For example to obtain a regex matching any job
* run on the jobtracker started at 200707121733, we would use :
*
* JobID.getTaskIDsPattern("200707121733", null);
*
* which will return :
* "job_200707121733_[0-9]*"
* @param jtIdentifier jobTracker identifier, or null
* @param jobId job number, or null
* @return a regex pattern matching JobIDs
*/
@Deprecated
public static String getJobIDsPattern(String jtIdentifier, Integer jobId) {
StringBuilder builder = new StringBuilder(JOB).append(SEPARATOR);
builder.append(getJobIDsPatternWOPrefix(jtIdentifier, jobId));
return builder.toString();
}
@Deprecated
static StringBuilder getJobIDsPatternWOPrefix(String jtIdentifier,
Integer jobId) {
StringBuilder builder = new StringBuilder();
if (jtIdentifier != null) {
builder.append(jtIdentifier);
} else {
builder.append("[^").append(SEPARATOR).append("]*");
}
builder.append(SEPARATOR)
.append(jobId != null ? idFormat.format(jobId) : "[0-9]*");
return builder;
}
}