Package com.oracle.bmc.budget

Interface CostAd

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    CostAdClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190111")
public interface CostAd
extends AutoCloseable
    Use the Budgets API to manage budgets and budget alerts.

    For more information, see Budgets Overview. 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

      • createCostAlertSubscription

        CreateCostAlertSubscriptionResponse createCostAlertSubscription​(CreateCostAlertSubscriptionRequest request)
        Creates a new CostAlert Subscription.
        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/latest/budget/CreateCostAlertSubscriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCostAlertSubscription API.

      • createCostAnomalyMonitor

        CreateCostAnomalyMonitorResponse createCostAnomalyMonitor​(CreateCostAnomalyMonitorRequest request)
        Creates a new costAnomaly Monitor.
        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/latest/budget/CreateCostAnomalyMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateCostAnomalyMonitor API.

      • deleteCostAlertSubscription

        DeleteCostAlertSubscriptionResponse deleteCostAlertSubscription​(DeleteCostAlertSubscriptionRequest request)
        Deletes a specified CostAlertSubscription 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 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/latest/budget/DeleteCostAlertSubscriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCostAlertSubscription API.

      • deleteCostAnomalyMonitor

        DeleteCostAnomalyMonitorResponse deleteCostAnomalyMonitor​(DeleteCostAnomalyMonitorRequest request)
        Deletes a specified CostAnomalyMonitor 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 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/latest/budget/DeleteCostAnomalyMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteCostAnomalyMonitor API.

      • disableCostAnomalyMonitor

        DisableCostAnomalyMonitorResponse disableCostAnomalyMonitor​(DisableCostAnomalyMonitorRequest request)
        Disables the cost anomaly monitor.

        This stops cost anomaly detection for targeted resource(s).

        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/latest/budget/DisableCostAnomalyMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DisableCostAnomalyMonitor API.

      • enableCostAnomalyMonitor

        EnableCostAnomalyMonitorResponse enableCostAnomalyMonitor​(EnableCostAnomalyMonitorRequest request)
        Enables the cost anomaly monitor.

        This (re)starts the cost anomaly detection for targeted resource(s).

        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/latest/budget/EnableCostAnomalyMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use EnableCostAnomalyMonitor API.

      • getCostAlertSubscription

        GetCostAlertSubscriptionResponse getCostAlertSubscription​(GetCostAlertSubscriptionRequest request)
        Gets a CostAlertSubscription by the identifier.
        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/latest/budget/GetCostAlertSubscriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCostAlertSubscription API.

      • getCostAnomalyEvent

        GetCostAnomalyEventResponse getCostAnomalyEvent​(GetCostAnomalyEventRequest request)
        Gets a CostAnomalyEvent by the identifier.
        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/latest/budget/GetCostAnomalyEventExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCostAnomalyEvent API.

      • getCostAnomalyMonitor

        GetCostAnomalyMonitorResponse getCostAnomalyMonitor​(GetCostAnomalyMonitorRequest request)
        Gets a CostAnomalyMonitor by the identifier.
        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/latest/budget/GetCostAnomalyMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetCostAnomalyMonitor API.

      • listCostAlertSubscriptions

        ListCostAlertSubscriptionsResponse listCostAlertSubscriptions​(ListCostAlertSubscriptionsRequest request)
        Gets a list of Cost Alert Subscription in a 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 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/latest/budget/ListCostAlertSubscriptionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCostAlertSubscriptions API.

      • listCostAnomalyEvents

        ListCostAnomalyEventsResponse listCostAnomalyEvents​(ListCostAnomalyEventsRequest request)
        Gets a list of Cost Anomaly Event in a 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 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/latest/budget/ListCostAnomalyEventsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCostAnomalyEvents API.

      • listCostAnomalyMonitors

        ListCostAnomalyMonitorsResponse listCostAnomalyMonitors​(ListCostAnomalyMonitorsRequest request)
        Gets a list of Cost Anomaly Monitors in a 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 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/latest/budget/ListCostAnomalyMonitorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListCostAnomalyMonitors API.

      • summarizeCostAnomalyEventAnalytics

        SummarizeCostAnomalyEventAnalyticsResponse summarizeCostAnomalyEventAnalytics​(SummarizeCostAnomalyEventAnalyticsRequest request)
        Gets a list of Cost Anomaly Events analytics summary - aggregated metrics for a given time period.
        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/latest/budget/SummarizeCostAnomalyEventAnalyticsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use SummarizeCostAnomalyEventAnalytics API.

      • updateCostAlertSubscription

        UpdateCostAlertSubscriptionResponse updateCostAlertSubscription​(UpdateCostAlertSubscriptionRequest request)
        Update a CostAlertSubscription identified by the OCID.
        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/latest/budget/UpdateCostAlertSubscriptionExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCostAlertSubscription API.

      • updateCostAnomalyEvent

        UpdateCostAnomalyEventResponse updateCostAnomalyEvent​(UpdateCostAnomalyEventRequest request)
        Update a CostAnomalyEvent identified by the OCID.
        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/latest/budget/UpdateCostAnomalyEventExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCostAnomalyEvent API.

      • updateCostAnomalyMonitor

        UpdateCostAnomalyMonitorResponse updateCostAnomalyMonitor​(UpdateCostAnomalyMonitorRequest request)
        Update a CostAnomalyMonitor identified by the OCID.
        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/latest/budget/UpdateCostAnomalyMonitorExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateCostAnomalyMonitor API.

      • getWaiters

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

      • getPaginators

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