Package org.azd.extensionmanagement

Class ExtensionManagementRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.extensionmanagement.ExtensionManagementRequestBuilder

public class ExtensionManagementRequestBuilder
extends BaseRequestBuilder

Extension management request builder to manage Extension management Api.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtensionManagementRequestBuilder.GetQueryParameters	Represents the query parameters.
static class	ExtensionManagementRequestBuilder.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
ExtensionManagementRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
InstalledExtension	get(String extensionId, String publisherId)	Get an installed extension by its publisher and extension id.
InstalledExtension	get(String extensionId, String publisherId, String[] assetTypes)	Get an installed extension by its publisher and extension id.
CompletableFuture<InstalledExtension>	getAsync(String extensionId, String publisherId)	Get an installed extension by its publisher and extension id.
CompletableFuture<InstalledExtension>	getAsync(String extensionId, String publisherId, String[] assetTypes)	Get an installed extension by its publisher and extension id.
InstalledExtension	install(InstallExtensionRequest installExtensionRequest)	Install the specified extension
CompletableFuture<InstalledExtension>	installAsync(InstallExtensionRequest installExtensionRequest)	Install the specified extension
InstalledExtensions	list()	List the installed extensions
InstalledExtensions	list(Consumer<ExtensionManagementRequestBuilder.RequestConfiguration> requestConfiguration)	List the installed extensions
CompletableFuture<InstalledExtensions>	listAsync()	List the installed extensions
CompletableFuture<InstalledExtensions>	listAsync(Consumer<ExtensionManagementRequestBuilder.RequestConfiguration> requestConfiguration)	List the installed extensions
Void	uninstall(UnInstallExtensionRequest unInstallExtensionRequest)	Uninstall the specified extension
CompletableFuture<Void>	uninstallAsync(UnInstallExtensionRequest unInstallExtensionRequest)	Uninstall the specified extension
InstalledExtension	update(UpdateExtensionRequest updateExtensionRequest)	Enable/disable an extension
CompletableFuture<InstalledExtension>	updateAsync(UpdateExtensionRequest updateExtensionRequest)	Enable/disable an extension

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

ExtensionManagementRequestBuilder

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

getAsync

public CompletableFuture<InstalledExtension> getAsync(String extensionId,
 String publisherId)
                                               throws AzDException

Get an installed extension by its publisher and extension id.

Parameters:

extensionId - Id of the extension. Example: "sonarqube".

publisherId - Id of the publisher. Example: "sonarsource".

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

getAsync

public CompletableFuture<InstalledExtension> getAsync(String extensionId,
 String publisherId,
 String[] assetTypes)
                                               throws AzDException

Get an installed extension by its publisher and extension id.

Parameters:

extensionId - Id of the extension. Example: "sonarqube".

publisherId - Id of the publisher. Example: "sonarsource".

assetTypes - type of asset

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<InstalledExtensions> listAsync()
                                                 throws AzDException

List the installed extensions

Returns:

InstalledExtensions InstalledExtensions

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<InstalledExtensions> listAsync(Consumer<ExtensionManagementRequestBuilder.RequestConfiguration> requestConfiguration)
                                                 throws AzDException

List the installed extensions

Parameters:

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

Returns:

InstalledExtensions InstalledExtensions

Throws:

AzDException - Default Api Exception handler.

installAsync

public CompletableFuture<InstalledExtension> installAsync(InstallExtensionRequest installExtensionRequest)
                                                   throws AzDException

Install the specified extension

Parameters:

installExtensionRequest - Publisher id and Extension id to install the extension. Optionally specify the version.

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

uninstallAsync

public CompletableFuture<Void> uninstallAsync(UnInstallExtensionRequest unInstallExtensionRequest)
                                       throws AzDException

Uninstall the specified extension

Parameters:

unInstallExtensionRequest - Specify the publisher id and extension id to uninstall the extension. Optionally specify the reason and reason code.

Throws:

AzDException - Default Api Exception handler.

updateAsync

public CompletableFuture<InstalledExtension> updateAsync(UpdateExtensionRequest updateExtensionRequest)
                                                  throws AzDException

Enable/disable an extension

Parameters:

updateExtensionRequest - Specify the publisher id, extension id and extension flag value to enable/disable the extension.

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

get

public InstalledExtension get(String extensionId,
 String publisherId)
                       throws AzDException

Get an installed extension by its publisher and extension id.

Parameters:

extensionId - Id of the extension. Example: "sonarqube".

publisherId - Id of the publisher. Example: "sonarsource".

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

get

public InstalledExtension get(String extensionId,
 String publisherId,
 String[] assetTypes)
                       throws AzDException

Get an installed extension by its publisher and extension id.

Parameters:

extensionId - Id of the extension. Example: "sonarqube".

publisherId - Id of the publisher. Example: "sonarsource".

assetTypes - type of asset

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

list

public InstalledExtensions list()
                         throws AzDException

List the installed extensions

Returns:

InstalledExtensions InstalledExtensions

Throws:

AzDException - Default Api Exception handler.

list

public InstalledExtensions list(Consumer<ExtensionManagementRequestBuilder.RequestConfiguration> requestConfiguration)
                         throws AzDException

List the installed extensions

Parameters:

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

Returns:

InstalledExtensions InstalledExtensions

Throws:

AzDException - Default Api Exception handler.

install

public InstalledExtension install(InstallExtensionRequest installExtensionRequest)
                           throws AzDException

Install the specified extension

Parameters:

installExtensionRequest - Publisher id and Extension id to install the extension. Optionally specify the version.

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.

uninstall

public Void uninstall(UnInstallExtensionRequest unInstallExtensionRequest)
               throws AzDException

Uninstall the specified extension

Parameters:

unInstallExtensionRequest - Specify the publisher id and extension id to uninstall the extension. Optionally specify the reason and reason code.

Throws:

AzDException - Default Api Exception handler.

update

public InstalledExtension update(UpdateExtensionRequest updateExtensionRequest)
                          throws AzDException

Enable/disable an extension

Parameters:

updateExtensionRequest - Specify the publisher id, extension id and extension flag value to enable/disable the extension.

Returns:

InstalledExtension InstalledExtension

Throws:

AzDException - Default Api Exception handler.