njnm.plugins.aws_batch

Class AwsBatchBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

njnm.plugins.aws_batch.AwsBatchBuilder

All Implemented Interfaces:

hudson.ExtensionPoint, hudson.model.Describable<hudson.tasks.Builder>, hudson.tasks.BuildStep

public class AwsBatchBuilder
extends hudson.tasks.Builder

AWS Batch Builder Builder.

This provides a minimum viable product for running jobs on AWS batch from jenkins.

Author:

Neal Fultz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsBatchBuilder.DescriptorImpl Descriptor for AwsBatchBuilder.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Nested classes/interfaces inherited from interface hudson.tasks.BuildStep

hudson.tasks.BuildStep.PublisherList

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
AwsBatchBuilder(String jobname, String jobdefinition, List<String> command, String jobqueue, Integer vcpu, Integer memory, Integer retries, Map<String,String> params, Map<String,String> environment)
AwsBatchBuilder(String jobname, String jobdefinition, String command, String jobqueue, Integer vcpu, Integer memory, Integer retries)
AwsBatchBuilder(String jobname, String jobdefinition, String command, String jobqueue, String vcpu, String memory, String retries) This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

Method Summary

Modifier and Type	Method and Description
String	getCommand()
AwsBatchBuilder.DescriptorImpl	getDescriptor() Hudson defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object.
String	getJobdefinition() We'll use these from the config.jelly.
String	getJobname()
String	getJobqueue()
String	getMemory()
String	getRetries()
String	getVcpu()
boolean	perform(hudson.model.AbstractBuild build, hudson.Launcher launcher, hudson.model.BuildListener listener)
boolean	prebuild(hudson.model.AbstractBuild<?,?> abstractBuild, hudson.model.BuildListener buildListener)
String	toString()

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform

Methods inherited from class java.lang.Object

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

Constructor Detail

AwsBatchBuilder

@DataBoundConstructor
public AwsBatchBuilder(String jobname,
                                             String jobdefinition,
                                             String command,
                                             String jobqueue,
                                             String vcpu,
                                             String memory,
                                             String retries)

This annotation tells Hudson to call this constructor, with values from the configuration form page with matching parameter names.

AwsBatchBuilder

public AwsBatchBuilder(String jobname,
                       String jobdefinition,
                       String command,
                       String jobqueue,
                       Integer vcpu,
                       Integer memory,
                       Integer retries)

AwsBatchBuilder

public AwsBatchBuilder(String jobname,
                       String jobdefinition,
                       List<String> command,
                       String jobqueue,
                       Integer vcpu,
                       Integer memory,
                       Integer retries,
                       Map<String,String> params,
                       Map<String,String> environment)

Method Detail

getJobdefinition

public String getJobdefinition()

We'll use these from the config.jelly.

getJobname

public String getJobname()

getJobqueue

public String getJobqueue()

getCommand

public String getCommand()

getVcpu

public String getVcpu()

getMemory

public String getMemory()

getRetries

public String getRetries()

perform

public boolean perform(hudson.model.AbstractBuild build,
                       hudson.Launcher launcher,
                       hudson.model.BuildListener listener)
                throws hudson.AbortException,
                       InterruptedException

Specified by:

perform in interface hudson.tasks.BuildStep

Overrides:

perform in class hudson.tasks.BuildStepCompatibilityLayer

Throws:

hudson.AbortException

InterruptedException

getDescriptor

public AwsBatchBuilder.DescriptorImpl getDescriptor()

Hudson defines a method Builder.getDescriptor(), which returns the corresponding Descriptor object. Since we know that it's actually AwsBatchBuilder.DescriptorImpl, override the method and give a better return type, so that we can access AwsBatchBuilder.DescriptorImpl methods more easily. This is not necessary, but just a coding style preference.

Specified by:

getDescriptor in interface hudson.model.Describable<hudson.tasks.Builder>

Overrides:

getDescriptor in class hudson.tasks.Builder

toString

public String toString()

Overrides:

toString in class Object

prebuild

public boolean prebuild(hudson.model.AbstractBuild<?,?> abstractBuild,
                        hudson.model.BuildListener buildListener)

Specified by:

prebuild in interface hudson.tasks.BuildStep

Overrides:

prebuild in class hudson.tasks.BuildStepCompatibilityLayer