Package com.oracle.bmc.dashboardservice

Interface DashboardGroup

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

    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

      • changeDashboardGroupCompartment

        ChangeDashboardGroupCompartmentResponse changeDashboardGroupCompartment​(ChangeDashboardGroupCompartmentRequest request)
        Moves a DashboardGroup resource from one compartment 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
        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/dashboardservice/ChangeDashboardGroupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeDashboardGroupCompartment API.

      • createDashboardGroup

        CreateDashboardGroupResponse createDashboardGroup​(CreateDashboardGroupRequest request)
        Creates a new dashboard group 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 group 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
        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/dashboardservice/CreateDashboardGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDashboardGroup API.

      • deleteDashboardGroup

        DeleteDashboardGroupResponse deleteDashboardGroup​(DeleteDashboardGroupRequest request)
        Deletes the specified dashboard group.

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

        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/dashboardservice/DeleteDashboardGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDashboardGroup API.

      • getDashboardGroup

        GetDashboardGroupResponse getDashboardGroup​(GetDashboardGroupRequest request)
        Gets the specified dashboard group’s information.

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

        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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/dashboardservice/GetDashboardGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDashboardGroup API.

      • listDashboardGroups

        ListDashboardGroupsResponse listDashboardGroups​(ListDashboardGroupsRequest request)
        Returns a list of dashboard groups with a specific compartment 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 uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. 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/dashboardservice/ListDashboardGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDashboardGroups API.

      • updateDashboardGroup

        UpdateDashboardGroupResponse updateDashboardGroup​(UpdateDashboardGroupRequest request)
        Updates the specified dashboard group.

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

        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/dashboardservice/UpdateDashboardGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDashboardGroup API.

      • getWaiters

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

      • getPaginators

        DashboardGroupPaginators 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.