org.jenkinsci.plugins.consulkv

Class ConsulKVBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

org.jenkinsci.plugins.consulkv.ConsulKVBuilder

All Implemented Interfaces:

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

public class ConsulKVBuilder
extends hudson.tasks.Builder
implements jenkins.tasks.SimpleBuildStep

Jenkins Plugin to READ/WRITE/DELETE K/V pairs from/to a Consul cluster, and set a build ENV variable to be used by downstream build steps.

Version:

2.0.0

Author:

Jimmy Ray

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface jenkins.tasks.SimpleBuildStep

jenkins.tasks.SimpleBuildStep.LastBuildAction, jenkins.tasks.SimpleBuildStep.LastBuildActionFactory

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

hudson.tasks.BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

hudson.ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor and Description
ConsulKVBuilder(String hostUrl, String key)
ConsulKVBuilder(String token, String hostUrl, String key, String keyValue, String urlOverride, String envVarKey, RequestMode requestMode, Integer timeoutConnection, Integer timeoutResponse, DebugMode debugMode) Deprecated.

Method Summary

Modifier and Type	Method and Description
DebugMode	getDebugMode()
ConsulKVBuilder.DescriptorImpl	getDescriptor()
String	getEnvVarKey()
String	getHostUrl()
String	getKey()
String	getKeyValue()
RequestMode	getRequestMode()
Integer	getTimeoutConnection()
Integer	getTimeoutResponse()
String	getToken()
String	getUrlOverride()
void	perform(hudson.model.Run<?,?> build, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener)
void	setDebugMode(DebugMode debugMode)
void	setEnvVarKey(String envVarKey)
void	setKeyValue(String keyValue)
void	setRequestMode(RequestMode requestMode)
void	setTimeoutConnection(Integer timeoutConnection)
void	setTimeoutResponse(Integer timeoutResponse)
void	setToken(String token)
void	setUrlOverride(String urlOverride)

Methods inherited from class hudson.tasks.Builder

all, getRequiredMonitorService, prebuild

Methods inherited from class hudson.tasks.BuildStepCompatibilityLayer

getProjectAction, getProjectAction, getProjectActions, perform, perform, prebuild

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.tasks.BuildStep

getProjectAction, getProjectActions, getRequiredMonitorService, perform, prebuild

Constructor Detail

ConsulKVBuilder

@Deprecated
public ConsulKVBuilder(String token,
                                   String hostUrl,
                                   String key,
                                   String keyValue,
                                   String urlOverride,
                                   String envVarKey,
                                   RequestMode requestMode,
                                   Integer timeoutConnection,
                                   Integer timeoutResponse,
                                   DebugMode debugMode)

Deprecated.

ConsulKVBuilder

@DataBoundConstructor
public ConsulKVBuilder(@CheckForNull
                                             String hostUrl,
                                             @CheckForNull
                                             String key)

Method Detail

getToken

public String getToken()

setToken

@DataBoundSetter
public void setToken(@CheckForNull
                                      String token)

getHostUrl

public String getHostUrl()

getKey

public String getKey()

getKeyValue

public String getKeyValue()

setKeyValue

@DataBoundSetter
public void setKeyValue(@CheckForNull
                                         String keyValue)

getUrlOverride

public String getUrlOverride()

setUrlOverride

@DataBoundSetter
public void setUrlOverride(@CheckForNull
                                            String urlOverride)

getEnvVarKey

public String getEnvVarKey()

setEnvVarKey

@DataBoundSetter
public void setEnvVarKey(@CheckForNull
                                          String envVarKey)

getRequestMode

public RequestMode getRequestMode()

setRequestMode

@DataBoundSetter
public void setRequestMode(@CheckForNull
                                            RequestMode requestMode)

getTimeoutConnection

public Integer getTimeoutConnection()

setTimeoutConnection

@DataBoundSetter
public void setTimeoutConnection(@CheckForNull
                                                  Integer timeoutConnection)

getTimeoutResponse

public Integer getTimeoutResponse()

setTimeoutResponse

@DataBoundSetter
public void setTimeoutResponse(@CheckForNull
                                                Integer timeoutResponse)

getDebugMode

public DebugMode getDebugMode()

setDebugMode

@DataBoundSetter
public void setDebugMode(@CheckForNull
                                          DebugMode debugMode)

getDescriptor

public ConsulKVBuilder.DescriptorImpl getDescriptor()

Specified by:

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

Overrides:

getDescriptor in class hudson.tasks.Builder

perform

public void perform(@Nonnull
                    hudson.model.Run<?,?> build,
                    @Nonnull
                    hudson.FilePath workspace,
                    @Nonnull
                    hudson.Launcher launcher,
                    @Nonnull
                    hudson.model.TaskListener listener)
             throws InterruptedException,
                    IOException

Specified by:

perform in interface jenkins.tasks.SimpleBuildStep

Throws:

InterruptedException

IOException