com.netflix.genie.core.jpa.entities

Class JobRequestEntity

java.lang.Object

com.netflix.genie.core.jpa.entities.BaseEntity

com.netflix.genie.core.jpa.entities.CommonFieldsEntity

com.netflix.genie.core.jpa.entities.SetupFileEntity

com.netflix.genie.core.jpa.entities.JobRequestEntity

All Implemented Interfaces:

java.io.Serializable

@Entity
public class JobRequestEntity
extends SetupFileEntity

Representation of the original Genie Job request.

Since:

3.0.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.netflix.genie.core.jpa.entities.CommonFieldsEntity

GENIE_ID_TAG_NAMESPACE, GENIE_NAME_TAG_NAMESPACE, GENIE_TAG_NAMESPACE, TAG_DELIMITER, TAG_DELIMITER_REGEX

Constructor Summary

Constructors

Constructor and Description
JobRequestEntity()

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getApplications() Gets the applications for the job as JSON array.
java.util.List<java.lang.String>	getApplicationsAsList() Get the applications to use for this job as a List of ids.
protected java.lang.String	getClusterCriterias() Get the cluster criteria's as a JSON string.
java.util.List<ClusterCriteria>	getClusterCriteriasAsList() Gets the cluster criteria which was specified to pick a cluster to run the job.
protected java.lang.String	getCommandCriteria() Get the command criteria specified to run this job in string format.
java.util.Set<java.lang.String>	getCommandCriteriaAsSet() Gets the command criteria which was specified to pick a command to run the job.
java.util.Optional<java.lang.Integer>	getCpu() Get the number of CPU's requested to run this job.
protected java.lang.String	getDependencies() Gets the dependencies for the job as JSON array.
java.util.Set<java.lang.String>	getDependenciesAsSet() Get the file dependencies as a set of strings.
JobRequest	getDTO() Get a DTO representing this job request.
java.util.Optional<java.lang.String>	getEmail() Gets the email address needed to send an email on job completion.
java.util.Optional<java.lang.String>	getGroup() Gets the group name of the user who submitted the job.
java.util.Optional<java.lang.Integer>	getMemory() Get the memory requested to run this job with.
java.util.Optional<java.lang.Integer>	getTimeout() Get the timeout (in seconds) requested by the user for this job.
protected void	setApplications(java.lang.String applications) Sets the dependencies for the job.
void	setApplicationsFromList(java.util.List<java.lang.String> applicationsList) Sets the dependencies for the job request from a set of strings.
protected void	setClusterCriterias(java.lang.String clusterCriterias) Set the cluster criterias JSON string.
void	setClusterCriteriasFromList(java.util.List<ClusterCriteria> clusterCriteriasList) Sets the list of cluster criteria specified to pick a cluster.
protected void	setCommandCriteria(java.lang.String commandCriteria) Set the command criteria string of JSON.
void	setCommandCriteriaFromSet(java.util.Set<java.lang.String> commandCriteriaSet) Sets the set of command criteria specified to pick a command.
protected void	setDependencies(java.lang.String dependencies) Sets the dependencies for the job.
void	setDependenciesFromSet(java.util.Set<java.lang.String> dependenciesSet) Sets the dependencies for the job request from a set of strings.

Methods inherited from class com.netflix.genie.core.jpa.entities.SetupFileEntity

getSetupFile

Methods inherited from class com.netflix.genie.core.jpa.entities.CommonFieldsEntity

getDescription, getFinalTags, getTags, setTags

Methods inherited from class com.netflix.genie.core.jpa.entities.BaseEntity

getCreated, getEntityVersion, getId, getUpdated, onCreateBaseEntity, onUpdateBaseEntity, setCreated, setEntityVersion, setId, setUpdated

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobRequestEntity

public JobRequestEntity()

Method Detail

getGroup

public java.util.Optional<java.lang.String> getGroup()

Gets the group name of the user who submitted the job.

Returns:

group

getClusterCriteriasAsList

public java.util.List<ClusterCriteria> getClusterCriteriasAsList()
                                                          throws GenieException

Gets the cluster criteria which was specified to pick a cluster to run the job.

Returns:

clusterCriterias

Throws:

GenieException - on any error

setClusterCriteriasFromList

public void setClusterCriteriasFromList(@NotEmpty
                                        java.util.List<ClusterCriteria> clusterCriteriasList)
                                 throws GenieException

Sets the list of cluster criteria specified to pick a cluster.

Parameters:

clusterCriteriasList - The criteria list. Not null or empty.

Throws:

GenieException - If any precondition isn't met.

getClusterCriterias

protected java.lang.String getClusterCriterias()

Get the cluster criteria's as a JSON string.

Returns:

The criteria's from the original request as a JSON string

setClusterCriterias

protected void setClusterCriterias(@NotBlank
                                   java.lang.String clusterCriterias)

Set the cluster criterias JSON string.

Parameters:

clusterCriterias - The cluster criterias.

getDependenciesAsSet

public java.util.Set<java.lang.String> getDependenciesAsSet()
                                                     throws GenieException

Get the file dependencies as a set of strings.

Returns:

The file dependencies for the job

Throws:

GenieException - On any exception

setDependenciesFromSet

public void setDependenciesFromSet(java.util.Set<java.lang.String> dependenciesSet)
                            throws GenieException

Sets the dependencies for the job request from a set of strings.

Parameters:

dependenciesSet - Dependent files for the job

Throws:

GenieException - for any processing error

getDependencies

protected java.lang.String getDependencies()

Gets the dependencies for the job as JSON array.

Returns:

dependencies

setDependencies

protected void setDependencies(java.lang.String dependencies)

Sets the dependencies for the job.

Parameters:

dependencies - Dependent files for the job in csv format

getEmail

public java.util.Optional<java.lang.String> getEmail()

Gets the email address needed to send an email on job completion.

Returns:

the email as an optional

getCommandCriteriaAsSet

public java.util.Set<java.lang.String> getCommandCriteriaAsSet()
                                                        throws GenieException

Gets the command criteria which was specified to pick a command to run the job.

Returns:

command criteria as a set of strings

Throws:

GenieException - on any processing error

setCommandCriteriaFromSet

public void setCommandCriteriaFromSet(@NotEmpty
                                      java.util.Set<java.lang.String> commandCriteriaSet)
                               throws GenieException

Sets the set of command criteria specified to pick a command.

Parameters:

commandCriteriaSet - The criteria set. Not null/empty

Throws:

GenieException - If any precondition isn't met.

getCommandCriteria

protected java.lang.String getCommandCriteria()

Get the command criteria specified to run this job in string format.

Returns:

command criteria as a JSON array string

setCommandCriteria

protected void setCommandCriteria(java.lang.String commandCriteria)

Set the command criteria string of JSON.

Parameters:

commandCriteria - A set of command criteria tags as a JSON array

getCpu

public java.util.Optional<java.lang.Integer> getCpu()

Get the number of CPU's requested to run this job.

Returns:

The number of CPU's as an Optional

getMemory

public java.util.Optional<java.lang.Integer> getMemory()

Get the memory requested to run this job with.

Returns:

The amount of memory the user requested for this job in MB as an Optional

getTimeout

public java.util.Optional<java.lang.Integer> getTimeout()

Get the timeout (in seconds) requested by the user for this job.

Returns:

The number of seconds before a timeout as an Optional

getApplicationsAsList

public java.util.List<java.lang.String> getApplicationsAsList()
                                                       throws GenieException

Get the applications to use for this job as a List of ids.

Returns:

The applications for the job

Throws:

GenieException - On any exception

setApplicationsFromList

public void setApplicationsFromList(java.util.List<java.lang.String> applicationsList)
                             throws GenieException

Sets the dependencies for the job request from a set of strings.

Parameters:

applicationsList - Application IDs for the job

Throws:

GenieException - for any processing error

getApplications

protected java.lang.String getApplications()

Gets the applications for the job as JSON array.

Returns:

applications

setApplications

protected void setApplications(java.lang.String applications)

Sets the dependencies for the job.

Parameters:

applications - Applications for the job in JSON array string

getDTO

public JobRequest getDTO()
                  throws GenieException

Get a DTO representing this job request.

Returns:

The read-only DTO.

Throws:

GenieException - For any processing error