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

Interface BitbucketEndpoint

All Superinterfaces:
Describable<BitbucketEndpoint>
All Known Implementing Classes:
AbstractBitbucketEndpoint, BitbucketCloudEndpoint, BitbucketServerEndpoint
public interface BitbucketEndpoint extends Describable<BitbucketEndpoint>
The implementation represents an endpoint configuration to be used in BitbucketSCMSource.
Since:
936.4.0

  • Method Details

    • getDisplayName

      @CheckForNull String getDisplayName()
      Name to use to describe the endpoint.
      Returns:
      the name to use for the endpoint

    • getRepositoryURL

      @NonNull String getRepositoryURL(@NonNull String repoOwner, @NonNull String repoSlug)
      The user facing URL of the specified repository.
      Parameters:
      repoOwner - the repository owner.
      repoSlug - the repository name
      Returns:
      the user facing URL of the specified repository.

    • getType

      @NonNull EndpointType getType()
      Returns the type of this endpoint.
      Returns:
      endpoint type.

    • getServerURL

      @NonNull String getServerURL()
      The URL of this endpoint.
      Returns:
      the URL of the endpoint.

    • getWebhook

      @NonNull BitbucketWebhookConfiguration getWebhook()
      Returns the webhook implementation that this endpoint is using to manage the incoming payload.
      Returns:
      the BitbucketWebhookConfiguration implementation selected for this endpoint.
      Since:
      937.0.0

    • isManageHooks

      @Deprecated(since="937.0.0", forRemoval=true) boolean isManageHooks()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getWebhook() instead of this to retrieve information webhook
      Returns true if and only if Jenkins is supposed to auto-manage hooks for this end-point.
      Returns:
      true if and only if Jenkins is supposed to auto-manage hooks for this end-point.

    • setManageHooks

      @Deprecated(since="937.0.0", forRemoval=true) void setManageHooks(boolean manageHooks, @CheckForNull String credentialsId)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getWebhook() instead of this to retrieve information webhook
      Sets if Jenkins is supposed to auto-manage hooks for this end-point.
      Parameters:
      manageHooks - if Jenkins must auto-manage hooks registration.
      credentialsId - credentialsId to use with rights to create or update web hook for Bitbucket repositories.

    • getCredentialsId

      @CheckForNull @Deprecated(since="937.0.0", forRemoval=true) String getCredentialsId()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getWebhook() instead of this to retrieve information webhook
      Returns the IdCredentials.getId() of the credentials to use for auto-management of hooks.
      Returns:
      the IdCredentials.getId() of the credentials to use for auto-management of hooks.

    • getEndpointJenkinsRootURL

      @Deprecated(since="937.0.0", forRemoval=true) @NonNull String getEndpointJenkinsRootURL()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getWebhook() instead of this to retrieve information webhook
      Jenkins Server Root URL to be used by this Bitbucket endpoint. The global setting from Jenkins.get().getRootUrl() will be used if this field is null or equals an empty string.
      Returns:
      the verbatim setting provided by endpoint configuration

    • credentials

      @Deprecated(since="937.0.0", forRemoval=true) @CheckForNull default com.cloudbees.plugins.credentials.common.StandardCredentials credentials()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getWebhook() instead of this to retrieve information webhook
      Looks up the StandardCredentials to use for auto-management of hooks.
      Returns:
      the credentials or null.

    • isEquals

      default boolean isEquals(BitbucketEndpoint endpoint)
      Returns if two endpoint are the equals.
      Parameters:
      endpoint - to compare
      Returns:
      true if endpoint are the same, false otherwise

    • getDescriptor

      default BitbucketEndpointDescriptor getDescriptor()
      Specified by:
      getDescriptor in interface Describable<BitbucketEndpoint>
      See Also: