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

Interface ApiJobRequest

All Superinterfaces:

CommonRequest

All Known Implementing Classes:

JobRequest

public interface ApiJobRequest
extends CommonRequest

The builder and methods available for a request generated by a REST API request.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ApiJobRequest.Builder Builder for a V4 Job Request.

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.
ExecutionResourceCriteria	getCriteria() The resource criteria that was supplied for the job.
JobMetadata	getMetadata() Get the metadata a user has supplied for the job including things like name, tags, etc.
AgentConfigRequest	getRequestedAgentConfig() Get the requested agent configuration.
JobEnvironmentRequest	getRequestedJobEnvironment() Get the environment parameters the user requested to be associated with the Agent.

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

getRequestedId, getResources

Method Detail

getCommandArgs

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

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

Returns:

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

getMetadata

JobMetadata getMetadata()

Get the metadata a user has supplied for the job including things like name, tags, etc.

Returns:

The metadata

getCriteria

ExecutionResourceCriteria getCriteria()

The resource criteria that was supplied for the job.

Returns:

The criteria used to select the cluster, command and optionally applications for the job

getRequestedJobEnvironment

JobEnvironmentRequest getRequestedJobEnvironment()

Get the environment parameters the user requested to be associated with the Agent.

Returns:

The requested agent environment

getRequestedAgentConfig

AgentConfigRequest getRequestedAgentConfig()

Get the requested agent configuration.

Returns:

The requested agent configuration parameters