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

Class Command

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable

public class Command
extends CommonResource

An immutable V4 Command resource.

Since:

4.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Command(java.lang.String id, java.time.Instant created, java.time.Instant updated, ExecutionEnvironment resources, CommandMetadata metadata, java.util.List<java.lang.String> executable, java.lang.Integer memory, long checkDelay, java.util.List<Criterion> clusterCriteria) Constructor.

Method Summary

Modifier and Type	Method and Description
java.util.List<Criterion>	getClusterCriteria() Get the ordered list of Criterion for this command to resolve clusters are runtime.
java.util.List<java.lang.String>	getExecutable() Get the executable elements (generally a binary followed optionally by default arguments) that should be used with this command when executing a job.
java.util.Optional<java.lang.Integer>	getMemory() Get the default amount of memory (in MB) to use for jobs which use this command.

Methods inherited from class java.lang.Object

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

Constructor Detail

Command

public Command(java.lang.String id,
               java.time.Instant created,
               java.time.Instant updated,
               @Nullable
               ExecutionEnvironment resources,
               CommandMetadata metadata,
               java.util.List<java.lang.String> executable,
               @Nullable
               java.lang.Integer memory,
               long checkDelay,
               @Nullable
               java.util.List<Criterion> clusterCriteria)

Constructor.

Parameters:

id - The unique identifier of this command

created - The time this command was created in the system

updated - The last time this command was updated in the system

resources - The execution resources associated with this command

metadata - The metadata associated with this command

executable - The executable command that will be used when a job is run with this command. Generally this will start with the binary and be followed optionally by default arguments. Must have at least one. Blanks will be removed

memory - The default memory that should be used to run a job with this command

checkDelay - The amount of time (in milliseconds) to delay between checks of job status for jobs run using this command. Min 1 but preferably much more

clusterCriteria - The ordered list of cluster Criterion that should be used to resolve which clusters this command can run on at job execution time

Method Detail

getMemory

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

Get the default amount of memory (in MB) to use for jobs which use this command.

Returns:

Optional wrapper of the amount of memory to use for a job

getExecutable

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

Get the executable elements (generally a binary followed optionally by default arguments) that should be used with this command when executing a job.

Returns:

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

getClusterCriteria

public java.util.List<Criterion> getClusterCriteria()

Get the ordered list of Criterion for this command to resolve clusters are runtime.

Returns:

The ordered list of Criterion as an immutable list. Any attempt to modify will throw an exception