Package org.azd.release.folders

Class ReleaseFoldersRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.release.folders.ReleaseFoldersRequestBuilder

public class ReleaseFoldersRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Release folders Api.

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

Method Summary

Modifier and Type	Method	Description
Void	delete(String path)	Deletes a definition folder for given folder name and path and all it's existing definitions.
CompletableFuture<Void>	deleteAsync(String path)	Deletes a definition folder for given folder name and path and all it's existing definitions.
Folders	list(String path)	Gets folders.
Folders	list(String path, FolderPathQueryOrder queryOrder)	Gets folders.
CompletableFuture<Folders>	listAsync(String path)	Gets folders.
CompletableFuture<Folders>	listAsync(String path, FolderPathQueryOrder queryOrder)	Gets 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

ReleaseFoldersRequestBuilder

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

deleteAsync

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

Deletes a definition folder for given folder name and path and all it's existing definitions.

Parameters:

path - Path of the folder to delete.

Throws:

AzDException - Default Api exception handler

listAsync

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

Gets folders.

Parameters:

path - Path of the folder.

Returns:

Collection of folder object Folders

Throws:

AzDException - Default Api exception handler

listAsync

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

Gets folders.

Parameters:

path - Path of the folder.

Returns:

Collection 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 - Path of the folder.

folder - Folder object to update.

Returns:

A folder object Folder

Throws:

AzDException - Default Api exception handler

delete

public Void delete(String path)
            throws AzDException

Deletes a definition folder for given folder name and path and all it's existing definitions.

Parameters:

path - Path of the folder to delete.

Throws:

AzDException - Default Api exception handler

list

public Folders list(String path)
             throws AzDException

Gets folders.

Parameters:

path - Path of the folder.

Returns:

Collection of folder object Folders

Throws:

AzDException - Default Api exception handler

list

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

Gets folders.

Parameters:

path - Path of the folder.

Returns:

Collection 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 - Path of the folder.

folder - Folder object to update.

Returns:

A folder object Folder

Throws:

AzDException - Default Api exception handler