Package com.oracle.bmc.osmanagementhub

Interface ReportingManagedInstance

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ReportingManagedInstanceClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public interface ReportingManagedInstance
extends AutoCloseable
    Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds.

    For more information, see Overview of OS Management Hub.

    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

      • getManagedInstanceAnalyticContent

        GetManagedInstanceAnalyticContentResponse getManagedInstanceAnalyticContent​(GetManagedInstanceAnalyticContentRequest request)
        Returns a report of managed instances matching the given filters.

        You can select CSV, XML, or JSON format.

        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.75.0/osmanagementhub/GetManagedInstanceAnalyticContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagedInstanceAnalyticContent API.

      • getManagedInstanceContent

        GetManagedInstanceContentResponse getManagedInstanceContent​(GetManagedInstanceContentRequest request)
        Returns a report for a single managed instance whose associated erratas match the given filters.

        You can select CSV, XML, or JSON format.

        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.75.0/osmanagementhub/GetManagedInstanceContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetManagedInstanceContent API.

      • summarizeManagedInstanceAnalytics

        SummarizeManagedInstanceAnalyticsResponse summarizeManagedInstanceAnalytics​(SummarizeManagedInstanceAnalyticsRequest request)
        Returns a list of user specified metrics for a collection of managed instances.
        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.75.0/osmanagementhub/SummarizeManagedInstanceAnalyticsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SummarizeManagedInstanceAnalytics API.