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

Class ApiJobRequest.Builder

java.lang.Object

com.netflix.genie.common.external.dtos.v4.CommonRequestImpl.Builder<ApiJobRequest.Builder>

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

Enclosing interface:

ApiJobRequest

public static class ApiJobRequest.Builder
extends com.netflix.genie.common.external.dtos.v4.CommonRequestImpl.Builder<ApiJobRequest.Builder>

Builder for a V4 Job Request.

Since:

4.0.0

Constructor Summary

Constructors

Constructor and Description
Builder(JobMetadata metadata, ExecutionResourceCriteria criteria) Constructor with required parameters.

Method Summary

Modifier and Type	Method and Description
ApiJobRequest	build() Build an immutable job request instance.
ApiJobRequest.Builder	withCommandArgs(java.util.List<java.lang.String> commandArgs) Set the ordered list of command line arguments to append to the command executable at runtime.
ApiJobRequest.Builder	withRequestedAgentConfig(AgentConfigRequest requestedAgentConfig) Set the configuration requested for the agent when this job is executed.
ApiJobRequest.Builder	withRequestedAgentEnvironment(JobEnvironmentRequest requestedJobEnvironment) Set the information provided by a user for the Agent execution environment.

Methods inherited from class com.netflix.genie.common.external.dtos.v4.CommonRequestImpl.Builder

withRequestedId, withResources

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(JobMetadata metadata,
               ExecutionResourceCriteria criteria)

Constructor with required parameters.

Parameters:

metadata - All user supplied metadata

criteria - All user supplied execution criteria

Method Detail

withCommandArgs

public ApiJobRequest.Builder withCommandArgs(@Nullable
                                             java.util.List<java.lang.String> commandArgs)

Set the ordered list of command line arguments to append to the command executable at runtime.

Parameters:

commandArgs - The arguments in the order they should be placed on the command line. Maximum of 10,000 characters per argument. Any blanks will be removed

Returns:

The builder

withRequestedAgentEnvironment

public ApiJobRequest.Builder withRequestedAgentEnvironment(@Nullable
                                                           JobEnvironmentRequest requestedJobEnvironment)

Set the information provided by a user for the Agent execution environment.

Parameters:

requestedJobEnvironment - the requested Genie job environment parameters

Returns:

The builder

withRequestedAgentConfig

public ApiJobRequest.Builder withRequestedAgentConfig(@Nullable
                                                      AgentConfigRequest requestedAgentConfig)

Set the configuration requested for the agent when this job is executed.

Parameters:

requestedAgentConfig - The requested configuration

Returns:

The builder

build

public ApiJobRequest build()

Build an immutable job request instance.

Returns:

An immutable representation of the user supplied information for a job request