Package org.azd.dashboard.widgettypes
Class WidgetTypesRequestBuilder
java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.dashboard.widgettypes.WidgetTypesRequestBuilder
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
ConstructorsConstructorDescriptionWidgetTypesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential) Instantiates a new RequestBuilder instance and sets the default values. -
Method Summary
Modifier and TypeMethodDescriptiongetMetadata(String contributionId) Get the widget metadata satisfying the specified contribution ID.getMetadataAsync(String contributionId) Get the widget metadata satisfying the specified contribution ID.Get all available widget metadata in alphabetical order.Get all available widget metadata in alphabetical order.Methods inherited from class org.azd.abstractions.BaseRequestBuilder
builder
-
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
Get all available widget metadata in alphabetical order.- Parameters:
scope- Widget scope.- Returns:
- WidgetTypesResponse object
WidgetTypesResponse - Throws:
AzDException- Default Api Exception handler.
-
getMetadata
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
Get all available widget metadata in alphabetical order.- Parameters:
scope- Widget scope.- Returns:
- WidgetTypesResponse object
WidgetTypesResponse - Throws:
AzDException- Default Api Exception handler.
-