com.netflix.genie.common.dto

Class JobRequest

java.lang.Object

com.netflix.genie.common.dto.BaseDTO

com.netflix.genie.common.dto.CommonDTO

com.netflix.genie.common.dto.SetupFileDTO

com.netflix.genie.common.dto.JobRequest

All Implemented Interfaces:

java.io.Serializable

public class JobRequest
extends SetupFileDTO

All information needed to make a request to run a new job.

Since:

3.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobRequest.Builder A builder to create job requests.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TIMEOUT_DURATION The default number of seconds from start before a job times out.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JobRequest(JobRequest.Builder builder) Constructor used by the builder build() method.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getApplications() Get the list of application id's this job is requesting to override the default applications with.
java.util.List<ClusterCriteria>	getClusterCriterias() Get the list of cluster criterias.
java.util.Set<java.lang.String>	getCommandCriteria() Get the set of command criteria.
java.util.Optional<java.lang.Integer>	getCpu() Get the number of CPU's requested to run this job.
java.util.Set<java.lang.String>	getDependencies() Get the dependencies that should be downloaded for this job.
java.util.Optional<java.lang.String>	getEmail() Get the email for the user.
java.util.Optional<java.lang.String>	getGroup() Get the group the user should be a member of.
java.util.Optional<java.lang.Integer>	getMemory() Get the amount of memory (in MB) requested to run this job with.
java.util.Optional<java.lang.Integer>	getTimeout() Get the amount of time requested (in seconds) before this job is timed out on the server.

Methods inherited from class com.netflix.genie.common.dto.SetupFileDTO

getSetupFile

Methods inherited from class com.netflix.genie.common.dto.CommonDTO

getDescription, getTags

Methods inherited from class com.netflix.genie.common.dto.BaseDTO

getCreated, getId, getUpdated, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT_DURATION

public static final int DEFAULT_TIMEOUT_DURATION

The default number of seconds from start before a job times out.

See Also:

Constant Field Values

Constructor Detail

JobRequest

protected JobRequest(JobRequest.Builder builder)

Constructor used by the builder build() method.

Parameters:

builder - The builder to use

Method Detail

getGroup

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

Get the group the user should be a member of.

Returns:

The group as an optional

getEmail

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

Get the email for the user.

Returns:

The email address as an Optional

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 amount of memory (in MB) requested to run this job with.

Returns:

The amount of memory as an Optional

getTimeout

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

Get the amount of time requested (in seconds) before this job is timed out on the server.

Returns:

The timeout as an Optional

getClusterCriterias

public java.util.List<ClusterCriteria> getClusterCriterias()

Get the list of cluster criterias.

Returns:

Read-only version of the cluster criterias. Attempts to modify will throw exception

getCommandCriteria

public java.util.Set<java.lang.String> getCommandCriteria()

Get the set of command criteria.

Returns:

Read-only version of the command criteria. Attempts to modify will throw exception

getDependencies

public java.util.Set<java.lang.String> getDependencies()

Get the dependencies that should be downloaded for this job.

Returns:

The file dependencies as a read-only set or null if none. Attempts to modify will throw exception

getApplications

public java.util.List<java.lang.String> getApplications()

Get the list of application id's this job is requesting to override the default applications with.

Returns:

The application ids as an read-only list. Attempts to modify with throw runtime exception.