com.spotify.helios.common.descriptors

Class JobId

java.lang.Object

com.spotify.helios.common.descriptors.Descriptor

com.spotify.helios.common.descriptors.JobId

All Implemented Interfaces:

Comparable<JobId>

public class JobId
extends Descriptor
implements Comparable<JobId>

Uniquely Identifies Jobs

Has a string representation in JSON of:

 "name:version:hashvalue"
 

The hash value is so that if you are talking to multiple clusters, and the job definitions are slightly different, even though they have the same name and version, they will still be uniquely identifiable. This is most important when executing commands against multiple clusters.

Many endpoints taking JobId can take an abbreviated JobId. That is, one without a the final colon and hash value.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobId.Builder

Constructor Summary

Constructors

Constructor and Description
JobId(String name, String version) Create a new job id with a specific name and version.
JobId(String name, String version, String hash) Create a fully qualified job id with name, version and hash.

Method Summary

Modifier and Type	Method and Description
int	compareTo(JobId jobId)
boolean	equals(Object obj)
static JobId	fromString(String id) Parse a job id string.
String	getHash()
String	getName()
String	getVersion()
int	hashCode()
boolean	isFullyQualified()
static JobId.Builder	newBuilder()
static JobId	parse(String id) Parse a job id string.
String	toShortString()
String	toString()

Methods inherited from class com.spotify.helios.common.descriptors.Descriptor

parse, parse, toJsonBytes, toJsonString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobId

public JobId(String name,
             String version,
             String hash)

Create a fully qualified job id with name, version and hash.

Parameters:

name - The name of the job.

version - The version of the job.

hash - The hash of the job.

JobId

public JobId(String name,
             String version)

Create a new job id with a specific name and version.

Parameters:

name - The name of the job.

version - the version of the job.

Method Detail

fromString

public static JobId fromString(String id)

Parse a job id string.

This parsing method can be used when input is trusted, i.e. failing to parse it indicates programming error and not bad input.

Parameters:

id - A string representation of the job ID.

Returns:

The JobId object.

See Also:

parse(String)

parse

public static JobId parse(String id)
                   throws JobIdParseException

Parse a job id string.

This parsing method can be used when input is not know to be correct. I.e. when parsing a job id supplied by the user in the cli or when parsing a request in the master rest interface.

Parameters:

id - A string representation of the job ID.

Returns:

The JobId object.

Throws:

JobIdParseException - If the ID cannot be parsed.

See Also:

fromString(String)

toString

public String toString()

Overrides:

toString in class Object

toShortString

public String toShortString()

getName

public String getName()

getVersion

public String getVersion()

getHash

public String getHash()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(JobId jobId)

Specified by:

compareTo in interface Comparable<JobId>

newBuilder

public static JobId.Builder newBuilder()

isFullyQualified

public boolean isFullyQualified()