Package com.cloudbees.jenkins.plugins.bitbucket.api.webhook

Interface BitbucketWebhookConfigurationBuilder

All Superinterfaces:

ExtensionPoint

All Known Subinterfaces:

NativeBitbucketWebhookConfigurationBuilder

All Known Implementing Classes:

AbstractBitbucketWebhookConfigurationBuilderImpl, CloudWebhookConfigurationBuilderImpl, PluginWebhookConfigurationBuilder, ServerWebhookConfigurationBuilderImpl

public interface BitbucketWebhookConfigurationBuilder
extends ExtensionPoint

Base interface that a builder must implement or extend to provide an instance of BitbucketWebhookConfiguration.

Since:

937.1.0

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Method Summary

Modifier and Type	Method	Description
BitbucketWebhookConfigurationBuilder	autoManaged(String credentialsId)	Enable the auto manage of webhook for each repository in a Jenkins project.
BitbucketWebhookConfiguration	build()	Returns an instance of BitbucketWebhookConfiguration using the provided configuration.
BitbucketWebhookConfigurationBuilder	callbackRootURL(String callbackRootURL)	Set the Jenkins root URL used to send event payload.
String	getId()	Returns the identifier of built BitbucketWebhookConfiguration.

Method Details

getId

@NonNull
String getId()

Returns the identifier of built BitbucketWebhookConfiguration.

Returns:

configuration identifier

See Also:

• BitbucketWebhookConfiguration.getId()

autoManaged

BitbucketWebhookConfigurationBuilder autoManaged(@NonNull
 String credentialsId)

Enable the auto manage of webhook for each repository in a Jenkins project.

Parameters:

credentialsId - with admin right to add, update or delete webhook of a bitbucket repository

Returns:

builder itself

callbackRootURL

BitbucketWebhookConfigurationBuilder callbackRootURL(@NonNull
 String callbackRootURL)

Set the Jenkins root URL used to send event payload.

Parameters:

callbackRootURL - URL of Jenkins accessible from the Bitbucket server instance.

Returns:

builder itself

build

BitbucketWebhookConfiguration build()

Returns an instance of BitbucketWebhookConfiguration using the provided configuration.

Returns:

instance of BitbucketWebhookConfiguration