com.netflix.genie.common.dto

Class Command.Builder

java.lang.Object

com.netflix.genie.common.dto.BaseDTO.Builder<T>

com.netflix.genie.common.dto.CommonDTO.Builder<T>

com.netflix.genie.common.dto.ExecutionEnvironmentDTO.Builder<Command.Builder>

com.netflix.genie.common.dto.Command.Builder

Enclosing class:

Command

public static class Command.Builder
extends ExecutionEnvironmentDTO.Builder<Command.Builder>

A builder to create commands.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder(java.lang.String name, java.lang.String user, java.lang.String version, CommandStatus status, java.util.List<java.lang.String> executableAndArguments, long checkDelay) Constructor with required fields.
Builder(java.lang.String name, java.lang.String user, java.lang.String version, CommandStatus status, java.lang.String executable, long checkDelay) Deprecated. Use Command.Builder#Builder(String, String, String, CommandStatus, List, long)

Method Summary

Modifier and Type	Method and Description
Command	build() Build the command.
Command.Builder	withExecutable(java.lang.String executable) Deprecated. this setter is provided transitionally to make both 'executable' and 'executableAndArguments' optional for API backward compatibility. The proper way to construct a Command is via the constructor Command.Builder#Builder(String, String, String, CommandStatus, List, long).
Command.Builder	withExecutableAndArguments(java.util.List<java.lang.String> executableAndArguments) Deprecated. this setter is provided transitionally to make both 'executable' and 'executableAndArguments' optional for API backward compatibility. The proper way to construct a Command is via the constructor Command.Builder#Builder(String, String, String, CommandStatus, List, long).
Command.Builder	withMemory(java.lang.Integer memory) Set the amount of memory (in MB) to default jobs run with this command to use.

Methods inherited from class com.netflix.genie.common.dto.ExecutionEnvironmentDTO.Builder

withConfigs, withDependencies, withSetupFile

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

withDescription, withMetadata, withMetadata, withTags

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

withCreated, withId, withUpdated

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

@Deprecated
public Builder(java.lang.String name,
                           java.lang.String user,
                           java.lang.String version,
                           CommandStatus status,
                           java.lang.String executable,
                           long checkDelay)

Deprecated. Use Command.Builder#Builder(String, String, String, CommandStatus, List, long)

Constructor which has required fields.

Parameters:

name - The name to use for the Command

user - The user to use for the Command

version - The version to use for the Command

status - The status of the Command

executable - The executable for the command

checkDelay - How long the system should go between checking the status of jobs run with this command. In milliseconds.

Builder

public Builder(java.lang.String name,
               java.lang.String user,
               java.lang.String version,
               CommandStatus status,
               java.util.List<java.lang.String> executableAndArguments,
               long checkDelay)

Constructor with required fields.

Parameters:

name - The name to use for the Command

user - The user to use for the Command

version - The version to use for the Command

status - The status of the Command

executableAndArguments - The executable for the command and its fixed arguments

checkDelay - How long the system should go between checking the status of jobs run with this command. In milliseconds.

Method Detail

withMemory

public Command.Builder withMemory(@Nullable
                                  java.lang.Integer memory)

Set the amount of memory (in MB) to default jobs run with this command to use.

Parameters:

memory - The default amount of memory (in MB) for jobs to use

Returns:

The builder

withExecutable

@Deprecated
public Command.Builder withExecutable(java.lang.String executable)

Deprecated. this setter is provided transitionally to make both 'executable' and 'executableAndArguments' optional for API backward compatibility. The proper way to construct a Command is via the constructor Command.Builder#Builder(String, String, String, CommandStatus, List, long).

Set the executable and its fixed arguments for this command. Note that this string is tokenized with a naive strategy (split on space) to break apart the executable from its fixed arguments. Escape characters and quotes are ignored in this process. To avoid this tokenization, use withExecutableAndArguments(List)

Parameters:

executable - the executable, possibly followed by arguments

Returns:

The builder

withExecutableAndArguments

@Deprecated
public Command.Builder withExecutableAndArguments(@Nullable
                                                              java.util.List<java.lang.String> executableAndArguments)

Deprecated. this setter is provided transitionally to make both 'executable' and 'executableAndArguments' optional for API backward compatibility. The proper way to construct a Command is via the constructor Command.Builder#Builder(String, String, String, CommandStatus, List, long).

Set the executable and its fixed arguments for this command.

Parameters:

executableAndArguments - the executable and its argument

Returns:

The builder

build

public Command build()

Build the command.

Returns:

Create the final read-only Command instance