com.oracle.bmc.apmsynthetics.ApmSynthetic Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.apmsynthetics;
import com.oracle.bmc.apmsynthetics.requests.*;
import com.oracle.bmc.apmsynthetics.responses.*;
/**
* Use the Application Performance Monitoring Synthetic Monitoring API to query synthetic scripts
* and monitors. For more information, see [Application Performance
* Monitoring](https://docs.oracle.com/iaas/application-performance-monitoring/index.html). This
* service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default
* if no circuit breaker configuration is defined by the user.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200630")
public interface ApmSynthetic extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the service.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
* Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this Region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* 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"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Gets aggregated network data for given executions.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* AggregateNetworkData API.
*/
AggregateNetworkDataResponse aggregateNetworkData(AggregateNetworkDataRequest request);
/**
* Registers a new dedicated vantage point.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* CreateDedicatedVantagePoint API.
*/
CreateDedicatedVantagePointResponse createDedicatedVantagePoint(
CreateDedicatedVantagePointRequest request);
/**
* Creates a new monitor.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use CreateMonitor API.
*/
CreateMonitorResponse createMonitor(CreateMonitorRequest request);
/**
* Registers a new On-premise vantage point.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* CreateOnPremiseVantagePoint API.
*/
CreateOnPremiseVantagePointResponse createOnPremiseVantagePoint(
CreateOnPremiseVantagePointRequest request);
/**
* Creates a new script.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use CreateScript API.
*/
CreateScriptResponse createScript(CreateScriptRequest request);
/**
* Registers a new worker.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use CreateWorker API.
*/
CreateWorkerResponse createWorker(CreateWorkerRequest request);
/**
* Deregisters the specified dedicated vantage point.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteDedicatedVantagePoint API.
*/
DeleteDedicatedVantagePointResponse deleteDedicatedVantagePoint(
DeleteDedicatedVantagePointRequest request);
/**
* Deletes the specified monitor.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use DeleteMonitor API.
*/
DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest request);
/**
* Deregisters the specified On-premise vantage point.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* DeleteOnPremiseVantagePoint API.
*/
DeleteOnPremiseVantagePointResponse deleteOnPremiseVantagePoint(
DeleteOnPremiseVantagePointRequest request);
/**
* Deletes the specified script.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use DeleteScript API.
*/
DeleteScriptResponse deleteScript(DeleteScriptRequest request);
/**
* Deregisters the specified worker.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use DeleteWorker API.
*/
DeleteWorkerResponse deleteWorker(DeleteWorkerRequest request);
/**
* Gets the details of the dedicated vantage point identified by the OCID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetDedicatedVantagePoint API.
*/
GetDedicatedVantagePointResponse getDedicatedVantagePoint(
GetDedicatedVantagePointRequest request);
/**
* Gets the configuration of the monitor identified by the OCID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetMonitor API.
*/
GetMonitorResponse getMonitor(GetMonitorRequest request);
/**
* 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.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetMonitorResult
* API.
*/
GetMonitorResultResponse getMonitorResult(GetMonitorResultRequest request);
/**
* Gets the details of the On-premise vantage point identified by the OCID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* GetOnPremiseVantagePoint API.
*/
GetOnPremiseVantagePointResponse getOnPremiseVantagePoint(
GetOnPremiseVantagePointRequest request);
/**
* Gets the configuration of the script identified by the OCID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetScript API.
*/
GetScriptResponse getScript(GetScriptRequest request);
/**
* Gets the details of the worker identified by the OCID.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use GetWorker API.
*/
GetWorkerResponse getWorker(GetWorkerRequest request);
/**
* Returns a list of dedicated vantage points.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListDedicatedVantagePoints API.
*/
ListDedicatedVantagePointsResponse listDedicatedVantagePoints(
ListDedicatedVantagePointsRequest request);
/**
* Returns a list of monitors.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListMonitors API.
*/
ListMonitorsResponse listMonitors(ListMonitorsRequest request);
/**
* Returns a list of On-premise vantage points.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListOnPremiseVantagePoints API.
*/
ListOnPremiseVantagePointsResponse listOnPremiseVantagePoints(
ListOnPremiseVantagePointsRequest request);
/**
* Returns a list of public vantage points.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* ListPublicVantagePoints API.
*/
ListPublicVantagePointsResponse listPublicVantagePoints(ListPublicVantagePointsRequest request);
/**
* Returns a list of scripts.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListScripts API.
*/
ListScriptsResponse listScripts(ListScriptsRequest request);
/**
* Returns a list of workers.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use ListWorkers API.
*/
ListWorkersResponse listWorkers(ListWorkersRequest request);
/**
* Updates the dedicated vantage point.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* UpdateDedicatedVantagePoint API.
*/
UpdateDedicatedVantagePointResponse updateDedicatedVantagePoint(
UpdateDedicatedVantagePointRequest request);
/**
* Updates the monitor.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use UpdateMonitor API.
*/
UpdateMonitorResponse updateMonitor(UpdateMonitorRequest request);
/**
* Updates the On-premise vantage point.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use
* UpdateOnPremiseVantagePoint API.
*/
UpdateOnPremiseVantagePointResponse updateOnPremiseVantagePoint(
UpdateOnPremiseVantagePointRequest request);
/**
* Updates the script.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use UpdateScript API.
*/
UpdateScriptResponse updateScript(UpdateScriptRequest request);
/**
* Updates the worker.
*
* @param request The request object containing the details to send
* @return 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 here to see how to use UpdateWorker API.
*/
UpdateWorkerResponse updateWorker(UpdateWorkerRequest request);
/**
* Gets the pre-configured paginators available for list operations in this service which may
* return multiple pages of data. These paginators provide an {@link java.lang.Iterable}
* interface so that service responses, or resources/records, can be iterated through without
* having to manually deal with pagination and page tokens.
*
* @return The service paginators.
*/
ApmSyntheticPaginators getPaginators();
}