com.netflix.genie.common.external.dtos.v4

Class JobRequest

java.lang.Object

com.netflix.genie.common.external.dtos.v4.JobRequest

All Implemented Interfaces:

AgentJobRequest, ApiJobRequest, CommonRequest, java.io.Serializable

public class JobRequest
extends java.lang.Object
implements AgentJobRequest, ApiJobRequest

All details a user will provide to Genie in order to run a job.

Since:

4.0.0

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	com.netflix.genie.common.external.dtos.v4.CommonRequestImpl.Builder<T extends com.netflix.genie.common.external.dtos.v4.CommonRequestImpl.Builder> Builder for common request fields.

Nested classes/interfaces inherited from interface com.netflix.genie.common.external.dtos.v4.AgentJobRequest

AgentJobRequest.Builder

Nested classes/interfaces inherited from interface com.netflix.genie.common.external.dtos.v4.ApiJobRequest

ApiJobRequest.Builder

Constructor Summary

Constructors

Constructor and Description
JobRequest(java.lang.String requestedId, ExecutionEnvironment resources, java.util.List<java.lang.String> commandArgs, JobMetadata metadata, ExecutionResourceCriteria criteria, JobEnvironmentRequest requestedJobEnvironment, AgentConfigRequest requestedAgentConfig) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCommandArgs() Get the command arguments a user has requested be appended to a command executable for their job.
java.util.Optional<java.lang.String>	getRequestedId() Get the ID the user has requested for this resource if one was added.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.netflix.genie.common.external.dtos.v4.AgentJobRequest

getCriteria, getMetadata, getRequestedAgentConfig

Methods inherited from interface com.netflix.genie.common.external.dtos.v4.ApiJobRequest

getCriteria, getMetadata, getRequestedAgentConfig, getRequestedJobEnvironment

Methods inherited from interface com.netflix.genie.common.external.dtos.v4.CommonRequest

getRequestedId, getResources

Constructor Detail

JobRequest

public JobRequest(@Nullable
                  java.lang.String requestedId,
                  @Nullable
                  ExecutionEnvironment resources,
                  @Nullable
                  java.util.List<java.lang.String> commandArgs,
                  JobMetadata metadata,
                  ExecutionResourceCriteria criteria,
                  @Nullable
                  JobEnvironmentRequest requestedJobEnvironment,
                  @Nullable
                  AgentConfigRequest requestedAgentConfig)

Constructor.

Parameters:

requestedId - The requested id of the job if one was provided by the user

resources - The execution resources (if any) provided by the user

commandArgs - Any command args provided by the user

metadata - Any metadata related to the job provided by the user

criteria - The criteria used by the server to determine execution resources (cluster, command, etc)

requestedJobEnvironment - The optional job environment request parameters

requestedAgentConfig - The optional configuration options for the Genie Agent

Method Detail

getCommandArgs

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

Get the command arguments a user has requested be appended to a command executable for their job.

Specified by:

getCommandArgs in interface AgentJobRequest

Specified by:

getCommandArgs in interface ApiJobRequest

Returns:

The command arguments as an immutable list. Any attempt to modify will throw exception

getRequestedId

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

Get the ID the user has requested for this resource if one was added.

Specified by:

getRequestedId in interface CommonRequest

Returns:

The ID wrapped in an Optional