com.mesosphere.velocity.marathon

Class MarathonStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

com.mesosphere.velocity.marathon.MarathonStep

All Implemented Interfaces:

AppConfig, hudson.ExtensionPoint, hudson.model.Describable<org.jenkinsci.plugins.workflow.steps.Step>

public class MarathonStep
extends org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
implements AppConfig

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MarathonStep.DescriptorImpl
static class	MarathonStep.MarathonStepExecution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor and Description
MarathonStep(String url)

Method Summary

Modifier and Type	Method and Description
String	getAppid() Deprecated. use getId()
String	getAppId() Get the configured Marathon Application Id.
String	getCredentialsId() Get the Jenkins credentials id for this configuration.
String	getDocker() Get the configured docker image name.
String	getFilename()
boolean	getForceUpdate() Get the value of whether the Marathon update should be forced.
String	getId() Get the application id for the "id" field.
List<MarathonLabel>	getLabels() Return a list of labels.
List<MarathonUri>	getUris() Return a list of configured URIs.
String	getUrl() Get the URL for the target Marathon instance.
void	setAppid(String appid) Deprecated. use setId(String)
void	setCredentialsId(String credentialsId)
void	setDocker(String docker)
void	setFilename(String filename)
void	setForceUpdate(boolean forceUpdate)
void	setId(String id) Set the application id for the "id" field.
void	setLabels(Map<String,String> labels)
void	setUris(List<String> uris)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

prepareInjector, start

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Detail

MarathonStep

@DataBoundConstructor
public MarathonStep(String url)

Method Detail

getAppId

public String getAppId()

Description copied from interface: AppConfig

Get the configured Marathon Application Id.

Specified by:

getAppId in interface AppConfig

Returns:

the Marathon Application Id

getUrl

public String getUrl()

Description copied from interface: AppConfig

Get the URL for the target Marathon instance.

Specified by:

getUrl in interface AppConfig

Returns:

Marathon instance URL

getForceUpdate

public boolean getForceUpdate()

Description copied from interface: AppConfig

Get the value of whether the Marathon update should be forced. If set to True, an in-progress deployment of this application will be canceled in favor of this update. If set to False, an error will occur because the application has a deployment in progress.

Specified by:

getForceUpdate in interface AppConfig

Returns:

whether to force the Marathon application update

setForceUpdate

@DataBoundSetter
public void setForceUpdate(boolean forceUpdate)

getDocker

public String getDocker()

Description copied from interface: AppConfig

Get the configured docker image name.

Specified by:

getDocker in interface AppConfig

Returns:

Docker image name

getCredentialsId

public String getCredentialsId()

Description copied from interface: AppConfig

Get the Jenkins credentials id for this configuration.

Specified by:

getCredentialsId in interface AppConfig

Returns:

credentials id

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getUris

public List<MarathonUri> getUris()

Description copied from interface: AppConfig

Return a list of configured URIs. These will be downloaded into the container sandbox prior to the Marathon application starting.

Specified by:

getUris in interface AppConfig

Returns:

list of URIs

setUris

@DataBoundSetter
public void setUris(List<String> uris)

getLabels

public List<MarathonLabel> getLabels()

Description copied from interface: AppConfig

Return a list of labels. Marathon uses Labels to attach metadata to an application.

Specified by:

getLabels in interface AppConfig

Returns:

list of labels

setLabels

@DataBoundSetter
public void setLabels(Map<String,String> labels)

setDocker

@DataBoundSetter
public void setDocker(String docker)

getAppid

@Deprecated
public String getAppid()

Deprecated. use getId()

Get the application id for the "appid" field.

Returns:

application id

setAppid

@Deprecated
 @DataBoundSetter
public void setAppid(String appid)

Deprecated. use setId(String)

Set the application id for the "appid" field.

Parameters:

appid - application id

getFilename

public String getFilename()

setFilename

@DataBoundSetter
public void setFilename(@Nonnull
                                         String filename)

getId

public String getId()

Get the application id for the "id" field.

Returns:

application id

Since:

1.3.3

setId

@DataBoundSetter
public void setId(String id)

Set the application id for the "id" field.

Parameters:

id - application id

Since:

1.3.3