Package org.azd.git.repositories

Class RepositoriesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.git.repositories.RepositoriesRequestBuilder

public class RepositoriesRequestBuilder
extends BaseRequestBuilder

Repositories request builder to manage Git repositories Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoriesRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	RepositoriesRequestBuilder.RequestConfiguration	Request configuration object for the query parameters.

Nested classes/interfaces inherited from class org.azd.abstractions.BaseRequestBuilder

BaseRequestBuilder.ProjectExcludeParameter

Field Summary

Fields inherited from class org.azd.abstractions.BaseRequestBuilder

accessTokenCredential, apiVersion, area, locationId, organizationUrl, serializer

Constructor Summary

Constructors

Constructor	Description
RepositoriesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
GitRepository	create(RepositoryRequest repositoryRequest)	Create a git repository in a team project.
GitRepository	create(RepositoryRequest repositoryRequest, String sourceRef)	Create a git repository in a team project.
CompletableFuture<GitRepository>	createAsync(RepositoryRequest repositoryRequest)	Create a git repository in a team project.
CompletableFuture<GitRepository>	createAsync(RepositoryRequest repositoryRequest, String sourceRef)	Create a git repository in a team project.
Void	delete(String repositoryId)	Delete a git repository
CompletableFuture<Void>	deleteAsync(String repositoryId)	Delete a git repository
GitRepository	get(String repositoryName)	Retrieve a git repository.
GitRepository	get(String repositoryName, boolean includeParent)	Retrieve a git repository with parent.
CompletableFuture<GitRepository>	getAsync(String repositoryName)	Retrieve a git repository.
CompletableFuture<GitRepository>	getAsync(String repositoryName, boolean includeParent)	Retrieve a git repository with parent.
Repositories	list()	Retrieve git repositories.
Repositories	list(Consumer<RepositoriesRequestBuilder.RequestConfiguration> requestConfiguration)	Retrieve git repositories.
CompletableFuture<Repositories>	listAsync()	Retrieve git repositories.
CompletableFuture<Repositories>	listAsync(Consumer<RepositoriesRequestBuilder.RequestConfiguration> requestConfiguration)	Retrieve git repositories.
GitDeletedRepositories	listDeleted()	Retrieve deleted git repositories.
CompletableFuture<GitDeletedRepositories>	listDeletedAsync()	Retrieve deleted git repositories.
RecycleBinRepositoriesRequestBuilder	recycleBin()	Request builder to manage recycle bin repositories.
GitRepository	update(String repositoryId, GitRepository gitRepository)	Updates the Git repository with either a new repo name or a new default branch.
CompletableFuture<GitRepository>	updateAsync(String repositoryId, GitRepository gitRepository)	Updates the Git repository with either a new repo name or a new default branch.

Methods inherited from class org.azd.abstractions.BaseRequestBuilder

builder

Methods inherited from class java.lang.Object

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

Constructor Details

RepositoriesRequestBuilder

public RepositoriesRequestBuilder(String organizationUrl,
 AccessTokenCredential accessTokenCredential)

Instantiates a new RequestBuilder instance and sets the default values.

Parameters:

organizationUrl - Represents organization location request url.

accessTokenCredential - Access token credential object.

Method Details

recycleBin

public RecycleBinRepositoriesRequestBuilder recycleBin()

Request builder to manage recycle bin repositories.

Returns:

RecycleBinRepositoriesRequestBuilder RecycleBinRepositoriesRequestBuilder.

createAsync

public CompletableFuture<GitRepository> createAsync(RepositoryRequest repositoryRequest)
                                             throws AzDException

Create a git repository in a team project.

Parameters:

repositoryRequest - New repository request.

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

createAsync

public CompletableFuture<GitRepository> createAsync(RepositoryRequest repositoryRequest,
 String sourceRef)
                                             throws AzDException

Create a git repository in a team project.

Parameters:

repositoryRequest - New repository request.

sourceRef - Specify the source refs to use while creating a fork repo

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

deleteAsync

public CompletableFuture<Void> deleteAsync(String repositoryId)
                                    throws AzDException

Delete a git repository

Parameters:

repositoryId - pass the repository id

Throws:

AzDException - Default Api Exception handler.

listDeletedAsync

public CompletableFuture<GitDeletedRepositories> listDeletedAsync()
                                                           throws AzDException

Retrieve deleted git repositories.

Returns:

Git deleted repository object GitDeletedRepositories

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<GitRepository> getAsync(String repositoryName)
                                          throws AzDException

Retrieve a git repository.

Parameters:

repositoryName - pass the repository name

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<GitRepository> getAsync(String repositoryName,
 boolean includeParent)
                                          throws AzDException

Retrieve a git repository with parent.

Parameters:

repositoryName - pass the repository name

includeParent - True to include parent repository.

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Repositories> listAsync()
                                          throws AzDException

Retrieve git repositories.

Returns:

array of git repositories

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Repositories> listAsync(Consumer<RepositoriesRequestBuilder.RequestConfiguration> requestConfiguration)
                                          throws AzDException

Retrieve git repositories.

Parameters:

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

array of git repositories

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<GitRepository> updateAsync(String repositoryId,
 GitRepository gitRepository)
                                             throws AzDException

Updates the Git repository with either a new repo name or a new default branch.

Parameters:

repositoryId - provide the repository id

gitRepository - Git repository object to update.

Returns:

a future repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

create

public GitRepository create(RepositoryRequest repositoryRequest)
                     throws AzDException

Create a git repository in a team project.

Parameters:

repositoryRequest - New repository request.

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

create

public GitRepository create(RepositoryRequest repositoryRequest,
 String sourceRef)
                     throws AzDException

Create a git repository in a team project.

Parameters:

repositoryRequest - New repository request.

sourceRef - Specify the source refs to use while creating a fork repo

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String repositoryId)
            throws AzDException

Delete a git repository

Parameters:

repositoryId - pass the repository id

Throws:

AzDException - Default Api Exception handler.

listDeleted

public GitDeletedRepositories listDeleted()
                                   throws AzDException

Retrieve deleted git repositories.

Returns:

Git deleted repository object GitDeletedRepositories

Throws:

AzDException - Default Api Exception handler.

get

public GitRepository get(String repositoryName)
                  throws AzDException

Retrieve a git repository.

Parameters:

repositoryName - pass the repository name

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

get

public GitRepository get(String repositoryName,
 boolean includeParent)
                  throws AzDException

Retrieve a git repository with parent.

Parameters:

repositoryName - pass the repository name

includeParent - True to include parent repository.

Returns:

git repository object GitRepository

Throws:

AzDException - Default Api Exception handler.

list

public Repositories list()
                  throws AzDException

Retrieve git repositories.

Returns:

array of git repositories

Throws:

AzDException - Default Api Exception handler.

list

public Repositories list(Consumer<RepositoriesRequestBuilder.RequestConfiguration> requestConfiguration)
                  throws AzDException

Retrieve git repositories.

Parameters:

requestConfiguration - Consumer of request configuration. This represents the query parameter for the request.

Returns:

array of git repositories

Throws:

AzDException - Default Api Exception handler.

update

public GitRepository update(String repositoryId,
 GitRepository gitRepository)
                     throws AzDException

Updates the Git repository with either a new repo name or a new default branch.

Parameters:

repositoryId - provide the repository id

gitRepository - Git repository object to update.

Returns:

a future repository object GitRepository

Throws:

AzDException - Default Api Exception handler.