Backstage
Docs
Github
Preparing search index...
@backstage/plugin-catalog-backend-module-bitbucket-server
BitbucketServerClient
Class BitbucketServerClient
A client for interacting with a Bitbucket Server instance
Index
Constructors
constructor
Methods
get
Default
Branch
get
File
get
Repository
list
Projects
list
Repositories
resolve
Path
from
Config
Constructors
constructor
new
BitbucketServerClient
(
options
:
{
config
:
BitbucketServerIntegrationConfig
}
,
)
:
BitbucketServerClient
Parameters
options
:
{
config
:
BitbucketServerIntegrationConfig
}
Returns
BitbucketServerClient
Methods
get
Default
Branch
getDefaultBranch
(
options
:
{
projectKey
:
string
;
repo
:
string
}
,
)
:
Promise
<
BitbucketServerDefaultBranch
>
Parameters
options
:
{
projectKey
:
string
;
repo
:
string
}
Returns
Promise
<
BitbucketServerDefaultBranch
>
get
File
getFile
(
options
:
{
path
:
string
;
projectKey
:
string
;
repo
:
string
}
,
)
:
Promise
<
Response
>
Parameters
options
:
{
path
:
string
;
projectKey
:
string
;
repo
:
string
}
Returns
Promise
<
Response
>
get
Repository
getRepository
(
options
:
{
projectKey
:
string
;
repo
:
string
}
,
)
:
Promise
<
BitbucketServerRepository
>
Parameters
options
:
{
projectKey
:
string
;
repo
:
string
}
Returns
Promise
<
BitbucketServerRepository
>
list
Projects
listProjects
(
options
:
{
listOptions
?:
BitbucketServerListOptions
}
,
)
:
Promise
<
BitbucketServerPagedResponse
<
BitbucketServerProject
>
>
Parameters
options
:
{
listOptions
?:
BitbucketServerListOptions
}
Returns
Promise
<
BitbucketServerPagedResponse
<
BitbucketServerProject
>
>
list
Repositories
listRepositories
(
options
:
{
listOptions
?:
BitbucketServerListOptions
;
projectKey
:
string
;
}
,
)
:
Promise
<
BitbucketServerPagedResponse
<
BitbucketServerRepository
>
>
Parameters
options
:
{
listOptions
?:
BitbucketServerListOptions
;
projectKey
:
string
}
Returns
Promise
<
BitbucketServerPagedResponse
<
BitbucketServerRepository
>
>
resolve
Path
resolvePath
(
options
:
{
path
:
string
;
projectKey
:
string
;
repo
:
string
}
,
)
:
{
path
:
string
}
Parameters
options
:
{
path
:
string
;
projectKey
:
string
;
repo
:
string
}
Returns
{
path
:
string
}
Static
from
Config
fromConfig
(
options
:
{
config
:
BitbucketServerIntegrationConfig
}
,
)
:
BitbucketServerClient
Parameters
options
:
{
config
:
BitbucketServerIntegrationConfig
}
Returns
BitbucketServerClient
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
get
Default
Branch
get
File
get
Repository
list
Projects
list
Repositories
resolve
Path
from
Config
Docs
Github
Backstage
Loading...
A client for interacting with a Bitbucket Server instance