Package com.oracle.bmc.apmsynthetics

Interface ApmSyntheticAsync

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ApmSyntheticAsyncClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public interface ApmSyntheticAsync
extends AutoCloseable
    Use the APM Availability Monitoring API to query Scripts, Monitors, Dedicated Vantage Points and On-Premise Vantage Points resources.

    For more information, see Application Performance Monitoring.

    • 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

      • aggregateNetworkData

        Future<AggregateNetworkDataResponse> aggregateNetworkData​(AggregateNetworkDataRequest request,
                                                          AsyncHandler<AggregateNetworkDataRequest,​AggregateNetworkDataResponse> handler)
        Gets aggregated network data for given executions.
        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.

      • createMonitor

        Future<CreateMonitorResponse> createMonitor​(CreateMonitorRequest request,
                                            AsyncHandler<CreateMonitorRequest,​CreateMonitorResponse> handler)
        Creates a new monitor.
        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.

      • createScript

        Future<CreateScriptResponse> createScript​(CreateScriptRequest request,
                                          AsyncHandler<CreateScriptRequest,​CreateScriptResponse> handler)
        Creates a new script.
        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.

      • createWorker

        Future<CreateWorkerResponse> createWorker​(CreateWorkerRequest request,
                                          AsyncHandler<CreateWorkerRequest,​CreateWorkerResponse> handler)
        Registers a new worker.
        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.

      • deleteMonitor

        Future<DeleteMonitorResponse> deleteMonitor​(DeleteMonitorRequest request,
                                            AsyncHandler<DeleteMonitorRequest,​DeleteMonitorResponse> handler)
        Deletes the specified monitor.
        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.

      • deleteScript

        Future<DeleteScriptResponse> deleteScript​(DeleteScriptRequest request,
                                          AsyncHandler<DeleteScriptRequest,​DeleteScriptResponse> handler)
        Deletes the specified script.
        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.

      • deleteWorker

        Future<DeleteWorkerResponse> deleteWorker​(DeleteWorkerRequest request,
                                          AsyncHandler<DeleteWorkerRequest,​DeleteWorkerResponse> handler)
        Deregisters the specified worker.
        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.

      • getDedicatedVantagePoint

        Future<GetDedicatedVantagePointResponse> getDedicatedVantagePoint​(GetDedicatedVantagePointRequest request,
                                                                  AsyncHandler<GetDedicatedVantagePointRequest,​GetDedicatedVantagePointResponse> handler)
        Gets the details of the dedicated vantage point identified by the OCID.
        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.

      • getMonitor

        Future<GetMonitorResponse> getMonitor​(GetMonitorRequest request,
                                      AsyncHandler<GetMonitorRequest,​GetMonitorResponse> handler)
        Gets the configuration of the monitor identified by the OCID.
        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.

      • getMonitorResult

        Future<GetMonitorResultResponse> getMonitorResult​(GetMonitorResultRequest request,
                                                  AsyncHandler<GetMonitorResultRequest,​GetMonitorResultResponse> handler)
        Gets the results for a specific execution of a monitor identified by OCID.

        The results are in a HAR file, Screenshot, Console Log or Network details.

        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.

      • getOnPremiseVantagePoint

        Future<GetOnPremiseVantagePointResponse> getOnPremiseVantagePoint​(GetOnPremiseVantagePointRequest request,
                                                                  AsyncHandler<GetOnPremiseVantagePointRequest,​GetOnPremiseVantagePointResponse> handler)
        Gets the details of the On-premise vantage point identified by the OCID.
        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.

      • getScript

        Future<GetScriptResponse> getScript​(GetScriptRequest request,
                                    AsyncHandler<GetScriptRequest,​GetScriptResponse> handler)
        Gets the configuration of the script identified by the OCID.
        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.

      • getWorker

        Future<GetWorkerResponse> getWorker​(GetWorkerRequest request,
                                    AsyncHandler<GetWorkerRequest,​GetWorkerResponse> handler)
        Gets the details of the worker identified by the OCID.
        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.

      • listMonitors

        Future<ListMonitorsResponse> listMonitors​(ListMonitorsRequest request,
                                          AsyncHandler<ListMonitorsRequest,​ListMonitorsResponse> handler)
        Returns a list of monitors.
        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.

      • listScripts

        Future<ListScriptsResponse> listScripts​(ListScriptsRequest request,
                                        AsyncHandler<ListScriptsRequest,​ListScriptsResponse> handler)
        Returns a list of scripts.
        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.

      • listWorkers

        Future<ListWorkersResponse> listWorkers​(ListWorkersRequest request,
                                        AsyncHandler<ListWorkersRequest,​ListWorkersResponse> handler)
        Returns a list of workers.
        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.

      • updateMonitor

        Future<UpdateMonitorResponse> updateMonitor​(UpdateMonitorRequest request,
                                            AsyncHandler<UpdateMonitorRequest,​UpdateMonitorResponse> handler)
        Updates the monitor.
        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.

      • updateScript

        Future<UpdateScriptResponse> updateScript​(UpdateScriptRequest request,
                                          AsyncHandler<UpdateScriptRequest,​UpdateScriptResponse> handler)
        Updates the script.
        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.

      • updateWorker

        Future<UpdateWorkerResponse> updateWorker​(UpdateWorkerRequest request,
                                          AsyncHandler<UpdateWorkerRequest,​UpdateWorkerResponse> handler)
        Updates the worker.
        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.