Package com.oracle.bmc.managementdashboard

Interface DashxApis

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    DashxApisClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200901")
public interface DashxApis
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.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • 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 service.

      • 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

      • changeManagementDashboardsCompartment

        ChangeManagementDashboardsCompartmentResponse changeManagementDashboardsCompartment​(ChangeManagementDashboardsCompartmentRequest request)
        Moves the dashboard from the existing compartment to a new compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/ChangeManagementDashboardsCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeManagementDashboardsCompartment API.

      • changeManagementSavedSearchesCompartment

        ChangeManagementSavedSearchesCompartmentResponse changeManagementSavedSearchesCompartment​(ChangeManagementSavedSearchesCompartmentRequest request)
        Moves the saved search from the existing compartment to a new compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/ChangeManagementSavedSearchesCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeManagementSavedSearchesCompartment API.

      • createManagementDashboard

        CreateManagementDashboardResponse createManagementDashboard​(CreateManagementDashboardRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/CreateManagementDashboardExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateManagementDashboard API.

      • createManagementSavedSearch

        CreateManagementSavedSearchResponse createManagementSavedSearch​(CreateManagementSavedSearchRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/CreateManagementSavedSearchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateManagementSavedSearch API.

      • deleteManagementDashboard

        DeleteManagementDashboardResponse deleteManagementDashboard​(DeleteManagementDashboardRequest request)
        Deletes a Dashboard by ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/DeleteManagementDashboardExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteManagementDashboard API.

      • deleteManagementSavedSearch

        DeleteManagementSavedSearchResponse deleteManagementSavedSearch​(DeleteManagementSavedSearchRequest request)
        Deletes a saved search by ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/DeleteManagementSavedSearchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteManagementSavedSearch API.

      • exportDashboard

        ExportDashboardResponse exportDashboard​(ExportDashboardRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/ExportDashboardExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ExportDashboard API.

      • getManagementDashboard

        GetManagementDashboardResponse getManagementDashboard​(GetManagementDashboardRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/GetManagementDashboardExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagementDashboard API.

      • getManagementSavedSearch

        GetManagementSavedSearchResponse getManagementSavedSearch​(GetManagementSavedSearchRequest request)
        Gets a saved search by ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/GetManagementSavedSearchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagementSavedSearch API.

      • importDashboard

        ImportDashboardResponse importDashboard​(ImportDashboardRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/ImportDashboardExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ImportDashboard API.

      • listManagementDashboards

        ListManagementDashboardsResponse listManagementDashboards​(ListManagementDashboardsRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/ListManagementDashboardsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementDashboards API.

      • listManagementSavedSearches

        ListManagementSavedSearchesResponse listManagementSavedSearches​(ListManagementSavedSearchesRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/ListManagementSavedSearchesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListManagementSavedSearches API.

      • updateManagementDashboard

        UpdateManagementDashboardResponse updateManagementDashboard​(UpdateManagementDashboardRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/UpdateManagementDashboardExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateManagementDashboard API.

      • updateManagementSavedSearch

        UpdateManagementSavedSearchResponse updateManagementSavedSearch​(UpdateManagementSavedSearchRequest request)
        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
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/managementdashboard/UpdateManagementSavedSearchExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateManagementSavedSearch API.

      • getWaiters

        DashxApisWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        DashxApisPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.