Package org.azd.dashboard.widgettypes

Class WidgetTypesRequestBuilder

java.lang.Object

org.azd.abstractions.BaseRequestBuilder

org.azd.dashboard.widgettypes.WidgetTypesRequestBuilder

public class WidgetTypesRequestBuilder
extends BaseRequestBuilder

Provides functionality to work with Dashboard widget types 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
WidgetTypesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)	Instantiates a new RequestBuilder instance and sets the default values.

Method Summary

Modifier and Type	Method	Description
WidgetMetadataResponse	getMetadata(String contributionId)	Get the widget metadata satisfying the specified contribution ID.
CompletableFuture<WidgetMetadataResponse>	getMetadataAsync(String contributionId)	Get the widget metadata satisfying the specified contribution ID.
WidgetTypesResponse	list(String scope)	Get all available widget metadata in alphabetical order.
CompletableFuture<WidgetTypesResponse>	listAsync(String scope)	Get all available widget metadata in alphabetical order.

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

WidgetTypesRequestBuilder

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

getMetadataAsync

public CompletableFuture<WidgetMetadataResponse> getMetadataAsync(String contributionId)
                                                           throws AzDException

Get the widget metadata satisfying the specified contribution ID.

Parameters:

contributionId - The ID of Contribution for the Widget.

Returns:

WidgetMetadataResponse object WidgetMetadataResponse

Throws:

AzDException - Default Api Exception handler.

listAsync

public CompletableFuture<WidgetTypesResponse> listAsync(String scope)
                                                 throws AzDException

Get all available widget metadata in alphabetical order.

Parameters:

scope - Widget scope.

Returns:

WidgetTypesResponse object WidgetTypesResponse

Throws:

AzDException - Default Api Exception handler.

getMetadata

public WidgetMetadataResponse getMetadata(String contributionId)
                                   throws AzDException

Get the widget metadata satisfying the specified contribution ID.

Parameters:

contributionId - The ID of Contribution for the Widget.

Returns:

WidgetMetadataResponse object WidgetMetadataResponse

Throws:

AzDException - Default Api Exception handler.

list

public WidgetTypesResponse list(String scope)
                         throws AzDException

Get all available widget metadata in alphabetical order.

Parameters:

scope - Widget scope.

Returns:

WidgetTypesResponse object WidgetTypesResponse

Throws:

AzDException - Default Api Exception handler.