Class BitbucketServerClient

A client for interacting with a Bitbucket Server instance

Index

Constructors

Methods

getDefaultBranch getFile getRepository listProjects listRepositories resolvePath fromConfig

Constructors

constructor

new BitbucketServerClient(
options: { config: BitbucketServerIntegrationConfig },
): BitbucketServerClient
Parameters
- options: { config: BitbucketServerIntegrationConfig }
Returns BitbucketServerClient
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:43

Methods

getDefaultBranch

getDefaultBranch(
options: { projectKey: string; repo: string },
): Promise<BitbucketServerDefaultBranch>
Parameters
- options: { projectKey: string; repo: string }
Returns Promise<BitbucketServerDefaultBranch>
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:102

getFile

getFile(
options: { path: string; projectKey: string; repo: string },
): Promise<Response>
Parameters
- options: { path: string; projectKey: string; repo: string }
Returns Promise<Response>
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:68

getRepository

getRepository(
options: { projectKey: string; repo: string },
): Promise<BitbucketServerRepository>
Parameters
- options: { projectKey: string; repo: string }
Returns Promise<BitbucketServerRepository>
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:82

listProjects

listProjects(
options: { listOptions?: BitbucketServerListOptions },
): Promise<BitbucketServerPagedResponse<BitbucketServerProject>>
Parameters
- options: { listOptions?: BitbucketServerListOptions }
Returns Promise<BitbucketServerPagedResponse<BitbucketServerProject>>
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:47

listRepositories

listRepositories(
    options: {
        listOptions?: BitbucketServerListOptions;
        projectKey: string;
    },
): Promise<BitbucketServerPagedResponse<BitbucketServerRepository>>
Parameters
- options: { listOptions?: BitbucketServerListOptions; projectKey: string }
Returns Promise<BitbucketServerPagedResponse<BitbucketServerRepository>>
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:56

resolvePath

resolvePath(
options: { path: string; projectKey: string; repo: string },
): { path: string }
Parameters
- options: { path: string; projectKey: string; repo: string }
Returns { path: string }
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:122

`Static`fromConfig

fromConfig(
options: { config: BitbucketServerIntegrationConfig },
): BitbucketServerClient
Parameters
- options: { config: BitbucketServerIntegrationConfig }
Returns BitbucketServerClient
- Defined in plugins/catalog-backend-module-bitbucket-server/src/lib/BitbucketServerClient.ts:37