Package com.oracle.bmc.dashboardservice

Interface DashboardAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DashboardAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20210731")
public interface DashboardAsync
extends AutoCloseable
    Use the Oracle Cloud Infrastructure Dashboards service API to manage dashboards in the Console.

    Dashboards provide an organized and customizable view of resources and their metrics in the Console. For more information, see Dashboards.

    *Important:** Resources for the Dashboards service are created in the tenacy's home region. Although it is possible to create dashboard and dashboard group resources in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the serice.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeDashboardGroup

        Future<ChangeDashboardGroupResponse> changeDashboardGroup​(ChangeDashboardGroupRequest request,
                                                          AsyncHandler<ChangeDashboardGroupRequest,​ChangeDashboardGroupResponse> handler)
        Moves a Dashboard resource from one dashboardGroup identifier to another.

        When provided, If-Match is checked against ETag values of the resource.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createDashboard

        Future<CreateDashboardResponse> createDashboard​(CreateDashboardRequest request,
                                                AsyncHandler<CreateDashboardRequest,​CreateDashboardResponse> handler)
        Creates a new dashboard in the dashboard group’s compartment using the details provided in request body.

        *Caution:** Resources for the Dashboard service are created in the tenacy's home region. Although it is possible to create dashboard resource in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteDashboard

        Future<DeleteDashboardResponse> deleteDashboard​(DeleteDashboardRequest request,
                                                AsyncHandler<DeleteDashboardRequest,​DeleteDashboardResponse> handler)
        Deletes the specified dashboard.

        Uses the dashboard’s OCID to determine which dashboard to delete.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDashboard

        Future<GetDashboardResponse> getDashboard​(GetDashboardRequest request,
                                          AsyncHandler<GetDashboardRequest,​GetDashboardResponse> handler)
        Gets the specified dashboard’s information.

        Uses the dashboard’s OCID to determine which dashboard to retrieve.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listDashboards

        Future<ListDashboardsResponse> listDashboards​(ListDashboardsRequest request,
                                              AsyncHandler<ListDashboardsRequest,​ListDashboardsResponse> handler)
        Returns a list of dashboards with a specific dashboard group ID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateDashboard

        Future<UpdateDashboardResponse> updateDashboard​(UpdateDashboardRequest request,
                                                AsyncHandler<UpdateDashboardRequest,​UpdateDashboardResponse> handler)
        Updates the specified dashboard.

        Uses the dashboard’s OCID to determine which dashboard to update.

        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.