Package com.oracle.bmc.managementdashboard

Interface DashxApisAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DashxApisAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200901")
public interface DashxApisAsync
extends AutoCloseable
    API for the Management Dashboard micro-service.

    Use this API for dashboard and saved search metadata preservation and to perform tasks such as creating a dashboard, creating a saved search, and obtaining a list of dashboards and saved searches in a compartment.

    • 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

      • createManagementDashboard

        Future<CreateManagementDashboardResponse> createManagementDashboard​(CreateManagementDashboardRequest request,
                                                                    AsyncHandler<CreateManagementDashboardRequest,​CreateManagementDashboardResponse> handler)
        Creates a new dashboard.

        Limit for number of saved searches in a dashboard is 20. Here’s an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard dashboard get --management-dashboard-id \"ocid1.managementdashboard.oc1..dashboardId1\" --query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard dashboard create command.

        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.

      • createManagementSavedSearch

        Future<CreateManagementSavedSearchResponse> createManagementSavedSearch​(CreateManagementSavedSearchRequest request,
                                                                        AsyncHandler<CreateManagementSavedSearchRequest,​CreateManagementSavedSearchResponse> handler)
        Creates a new saved search.

        Here’s an example of how you can use CLI to create a saved search. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard saved-search get --management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 --query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard saved-search create command.

        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.

      • exportDashboard

        Future<ExportDashboardResponse> exportDashboard​(ExportDashboardRequest request,
                                                AsyncHandler<ExportDashboardRequest,​ExportDashboardResponse> handler)
        Exports an array of dashboards and their saved searches.

        Export is designed to work with importDashboard. Here’s an example of how you can use CLI to export a dashboard: $oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > dashboards.json

        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.

      • getManagementDashboard

        Future<GetManagementDashboardResponse> getManagementDashboard​(GetManagementDashboardRequest request,
                                                              AsyncHandler<GetManagementDashboardRequest,​GetManagementDashboardResponse> handler)
        Gets a dashboard and its saved searches by ID.

        Deleted or unauthorized saved searches are marked by tile’s state property.

        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.

      • importDashboard

        Future<ImportDashboardResponse> importDashboard​(ImportDashboardRequest request,
                                                AsyncHandler<ImportDashboardRequest,​ImportDashboardResponse> handler)
        Imports an array of dashboards and their saved searches.

        Here’s an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > Import.json. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here’s an example of how you can use CLI to import: oci management-dashboard dashboard import --from-json file://Import.json

        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.

      • listManagementDashboards

        Future<ListManagementDashboardsResponse> listManagementDashboards​(ListManagementDashboardsRequest request,
                                                                  AsyncHandler<ListManagementDashboardsRequest,​ListManagementDashboardsResponse> handler)
        Gets the list of dashboards in a compartment with pagination.

        Returned properties are the summary.

        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.

      • listManagementSavedSearches

        Future<ListManagementSavedSearchesResponse> listManagementSavedSearches​(ListManagementSavedSearchesRequest request,
                                                                        AsyncHandler<ListManagementSavedSearchesRequest,​ListManagementSavedSearchesResponse> handler)
        Gets the list of saved searches in a compartment with pagination.

        Returned properties are the summary.

        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.

      • updateManagementDashboard

        Future<UpdateManagementDashboardResponse> updateManagementDashboard​(UpdateManagementDashboardRequest request,
                                                                    AsyncHandler<UpdateManagementDashboardRequest,​UpdateManagementDashboardResponse> handler)
        Updates an existing dashboard identified by ID path parameter.

        CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20.

        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.

      • updateManagementSavedSearch

        Future<UpdateManagementSavedSearchResponse> updateManagementSavedSearch​(UpdateManagementSavedSearchRequest request,
                                                                        AsyncHandler<UpdateManagementSavedSearchRequest,​UpdateManagementSavedSearchResponse> handler)
        Updates an existing saved search identified by ID path parameter.

        CompartmentId can be modified only by the changeCompartment API.

        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.