Package org.azd.build.folders

Class FoldersRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.build.folders.FoldersRequestBuilder

public class FoldersRequestBuilder
extends BaseRequestBuilder

Provides methods for working with folders of build definitions.

Nested Class Summary

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
FoldersRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
Folder	create(String path, Folder folder)	Creates a new folder.
CompletableFuture<Folder>	createAsync(String path, Folder folder)	Creates a new folder.
Void	delete(String path)	Deletes a definition folder.
CompletableFuture<Void>	deleteAsync(String path)	Deletes a definition folder.
Folders	list()	Gets a list of build definition folders.
Folders	list(String path, FolderQueryOrder queryOrder)	Gets a list of build definition folders.
CompletableFuture<Folders>	listAsync()	Gets a list of build definition folders.
CompletableFuture<Folders>	listAsync(String path, FolderQueryOrder queryOrder)	Gets a list of build definition folders.
Folder	update(String path, Folder folder)	Updates an existing folder at given existing path
CompletableFuture<Folder>	updateAsync(String path, Folder folder)	Updates an existing folder at given existing path

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

FoldersRequestBuilder

public FoldersRequestBuilder(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

createAsync

public CompletableFuture<Folder> createAsync(String path,
 Folder folder)
                                      throws AzDException

Creates a new folder.

Parameters:

path - The full path of the folder.

folder - Folder object with mandatory details.

Returns:

Folder Object Folder

Throws:

AzDException - Default Api Exception handler.

deleteAsync

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

Deletes a definition folder. Definitions and their corresponding builds will also be deleted.

Parameters:

path - The full path to the folder.

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Folders> listAsync()
                                     throws AzDException

Gets a list of build definition folders.

Returns:

List of folder Object Folders

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<Folders> listAsync(String path,
 FolderQueryOrder queryOrder)
                                     throws AzDException

Gets a list of build definition folders.

Returns:

List of folder Object Folders

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<Folder> updateAsync(String path,
 Folder folder)
                                      throws AzDException

Updates an existing folder at given existing path

Parameters:

path - The full path to the folder.

Returns:

Folder Object Folder

Throws:

AzDException - Default Api Exception handler.

create

public Folder create(String path,
 Folder folder)
              throws AzDException

Creates a new folder.

Parameters:

path - The full path of the folder.

folder - Folder object with mandatory details.

Returns:

Folder Object Folder

Throws:

AzDException - Default Api Exception handler.

delete

public Void delete(String path)
            throws AzDException

Deletes a definition folder. Definitions and their corresponding builds will also be deleted.

Parameters:

path - The full path to the folder.

Throws:

AzDException - Default Api Exception handler.

list

public Folders list()
             throws AzDException

Gets a list of build definition folders.

Returns:

List of folder Object Folders

Throws:

AzDException - Default Api Exception handler.

list

public Folders list(String path,
 FolderQueryOrder queryOrder)
             throws AzDException

Gets a list of build definition folders.

Returns:

List of folder Object Folders

Throws:

AzDException - Default Api Exception handler.

update

public Folder update(String path,
 Folder folder)
              throws AzDException

Updates an existing folder at given existing path

Parameters:

path - The full path to the folder.

Returns:

Folder Object Folder

Throws:

AzDException - Default Api Exception handler.