Package jetbrains.buildServer.vcshostings.bbcloud

Class BitBucketRepositoriesSearch

java.lang.Object

jetbrains.buildServer.vcshostings.bbcloud.BitBucketRepositoriesSearch

All Implemented Interfaces:

VcsSearch<VcsRepositories>

public class BitBucketRepositoriesSearch
extends Object
implements VcsSearch<VcsRepositories>

Constructor Summary

Constructors

Constructor	Description
BitBucketRepositoriesSearch(BitbucketClient client, OAuthToken token)

Method Summary

Modifier and Type	Method	Description
BitBucketVcsRepositories	get()	Obtains a list of entities from a VCS hosting service
BitBucketRepositoriesSearch	page(String pageId)	The ID of the page is assumed to be a query string of a URL returned by BitBucket including the `?` character, encoded in url-safe Base64.
BitBucketRepositoriesSearch	pageSize(int pageSize)	Sets custom page size for the results
BitBucketRepositoriesSearch	search(String searchString)	Sets a search string (if supported).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BitBucketRepositoriesSearch

public BitBucketRepositoriesSearch(BitbucketClient client,
                                   OAuthToken token)

Method Detail

search

public BitBucketRepositoriesSearch search(@NotNull
                                          String searchString)

Description copied from interface: VcsSearch

Sets a search string (if supported). The search string is matched across entity names

Specified by:

search in interface VcsSearch<VcsRepositories>

Parameters:

searchString - search string, case-insensitive

Returns:

the same object

pageSize

public BitBucketRepositoriesSearch pageSize(int pageSize)

Description copied from interface: VcsSearch

Sets custom page size for the results

Specified by:

pageSize in interface VcsSearch<VcsRepositories>

Parameters:

pageSize - custom page size

Returns:

the same object

page

public BitBucketRepositoriesSearch page(@NotNull
                                        String pageId)

The ID of the page is assumed to be a query string of a URL returned by BitBucket including the `?` character, encoded in url-safe Base64.

If current builder already has page size or search query set, they will be checked against those present in the pageId. If not matching, pageId has lower priority and will be ignored (as in such a case the ID comes from another paged request, and modification of its parameters may lead to unpredictable search results).

Specified by:

page in interface VcsSearch<VcsRepositories>

Parameters:

pageId - page id in form of a parameter string of an url returned by BitBucket as the url of the next page.

Returns:

get

public BitBucketVcsRepositories get()

Description copied from interface: VcsSearch

Obtains a list of entities from a VCS hosting service

Specified by:

get in interface VcsSearch<VcsRepositories>

Returns:

list of repositories with some additional information