Package io.jenkins.plugins.asyntai

Class AsyntaiKnowledgeSyncBuilder

java.lang.Object

hudson.tasks.BuildStepCompatibilityLayer

hudson.tasks.Builder

io.jenkins.plugins.asyntai.AsyntaiKnowledgeSyncBuilder

All Implemented Interfaces:

ExtensionPoint, Describable<Builder>, BuildStep, SimpleBuildStep

public class AsyntaiKnowledgeSyncBuilder
extends Builder
implements SimpleBuildStep

Build step that sends documentation files from the workspace to the Asyntai knowledge base. Works in freestyle jobs and in Pipeline as asyntaiKnowledgeSync.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AsyntaiKnowledgeSyncBuilder.DescriptorImpl

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

BuildStep.PublisherList

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

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

SimpleBuildStep.LastBuildAction, SimpleBuildStep.LastBuildActionFactory

Field Summary

Fields inherited from interface hudson.tasks.BuildStep

BUILDERS, PUBLISHERS

Constructor Summary

Constructors

Constructor	Description
AsyntaiKnowledgeSyncBuilder(String credentialsId)

Method Summary

Modifier and Type	Method	Description
String	getApiUrl()
String	getCredentialsId()
String	getExcludes()
String	getFiles()
String	getRootDirectory()
String	getTitlePrefix()
String	getWebsiteId()
boolean	isDryRun()
boolean	isPrune()
void	perform(Run<?,?> run, FilePath workspace, EnvVars env, Launcher launcher, TaskListener listener)
void	setApiUrl(String apiUrl)
void	setDryRun(boolean dryRun)
void	setExcludes(String excludes)
void	setFiles(String files)
void	setPrune(boolean prune)
void	setRootDirectory(String rootDirectory)
void	setTitlePrefix(String titlePrefix)
void	setWebsiteId(String websiteId)

Methods inherited from class hudson.tasks.Builder

all, getDescriptor, 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

Methods inherited from interface jenkins.tasks.SimpleBuildStep

perform, perform, requiresWorkspace

Constructor Details

AsyntaiKnowledgeSyncBuilder

@DataBoundConstructor
public AsyntaiKnowledgeSyncBuilder(String credentialsId)

Method Details

getCredentialsId

public String getCredentialsId()

getFiles

public String getFiles()

setFiles

@DataBoundSetter
public void setFiles(String files)

getExcludes

public String getExcludes()

setExcludes

@DataBoundSetter
public void setExcludes(String excludes)

getRootDirectory

public String getRootDirectory()

setRootDirectory

@DataBoundSetter
public void setRootDirectory(String rootDirectory)

getTitlePrefix

public String getTitlePrefix()

setTitlePrefix

@DataBoundSetter
public void setTitlePrefix(String titlePrefix)

getWebsiteId

public String getWebsiteId()

setWebsiteId

@DataBoundSetter
public void setWebsiteId(String websiteId)

isPrune

public boolean isPrune()

setPrune

@DataBoundSetter
public void setPrune(boolean prune)

isDryRun

public boolean isDryRun()

setDryRun

@DataBoundSetter
public void setDryRun(boolean dryRun)

getApiUrl

public String getApiUrl()

setApiUrl

@DataBoundSetter
public void setApiUrl(String apiUrl)

perform

public void perform(@NonNull
 Run<?,?> run,
 @NonNull
 FilePath workspace,
 @NonNull
 EnvVars env,
 @NonNull
 Launcher launcher,
 @NonNull
 TaskListener listener)
             throws InterruptedException,
IOException

Specified by:

perform in interface SimpleBuildStep

Throws:

InterruptedException

IOException