@Generated(value="OracleSDKGenerator", comments="API Version: 20200630") public interface ApmSynthetic extends AutoCloseable
Use the Application Performance Monitoring Synthetic Monitoring API to query synthetic scripts and monitors. For more information, see Application Performance Monitoring. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
AggregateNetworkDataResponse |
aggregateNetworkData(AggregateNetworkDataRequest request)
Gets aggregated network data for given executions.
|
CreateDedicatedVantagePointResponse |
createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request)
Registers a new dedicated vantage point.
|
CreateMonitorResponse |
createMonitor(CreateMonitorRequest request)
Creates a new monitor.
|
CreateOnPremiseVantagePointResponse |
createOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request)
Registers a new On-premise vantage point.
|
CreateScriptResponse |
createScript(CreateScriptRequest request)
Creates a new script.
|
CreateWorkerResponse |
createWorker(CreateWorkerRequest request)
Registers a new worker.
|
DeleteDedicatedVantagePointResponse |
deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request)
Deregisters the specified dedicated vantage point.
|
DeleteMonitorResponse |
deleteMonitor(DeleteMonitorRequest request)
Deletes the specified monitor.
|
DeleteOnPremiseVantagePointResponse |
deleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request)
Deregisters the specified On-premise vantage point.
|
DeleteScriptResponse |
deleteScript(DeleteScriptRequest request)
Deletes the specified script.
|
DeleteWorkerResponse |
deleteWorker(DeleteWorkerRequest request)
Deregisters the specified worker.
|
GetDedicatedVantagePointResponse |
getDedicatedVantagePoint(GetDedicatedVantagePointRequest request)
Gets the details of the dedicated vantage point identified by the OCID.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetMonitorResponse |
getMonitor(GetMonitorRequest request)
Gets the configuration of the monitor identified by the OCID.
|
GetMonitorResultResponse |
getMonitorResult(GetMonitorResultRequest request)
Gets the results for a specific execution of a monitor identified by OCID.
|
GetOnPremiseVantagePointResponse |
getOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request)
Gets the details of the On-premise vantage point identified by the OCID.
|
ApmSyntheticPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
GetScriptResponse |
getScript(GetScriptRequest request)
Gets the configuration of the script identified by the OCID.
|
GetWorkerResponse |
getWorker(GetWorkerRequest request)
Gets the details of the worker identified by the OCID.
|
ListDedicatedVantagePointsResponse |
listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request)
Returns a list of dedicated vantage points.
|
ListMonitorsResponse |
listMonitors(ListMonitorsRequest request)
Returns a list of monitors.
|
ListOnPremiseVantagePointsResponse |
listOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request)
Returns a list of On-premise vantage points.
|
ListPublicVantagePointsResponse |
listPublicVantagePoints(ListPublicVantagePointsRequest request)
Returns a list of public vantage points.
|
ListScriptsResponse |
listScripts(ListScriptsRequest request)
Returns a list of scripts.
|
ListWorkersResponse |
listWorkers(ListWorkersRequest request)
Returns a list of workers.
|
void |
refreshClient()
Rebuilds the client from scratch.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateDedicatedVantagePointResponse |
updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request)
Updates the dedicated vantage point.
|
UpdateMonitorResponse |
updateMonitor(UpdateMonitorRequest request)
Updates the monitor.
|
UpdateOnPremiseVantagePointResponse |
updateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request)
Updates the On-premise vantage point.
|
UpdateScriptResponse |
updateScript(UpdateScriptRequest request)
Updates the script.
|
UpdateWorkerResponse |
updateWorker(UpdateWorkerRequest request)
Updates the worker.
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateAggregateNetworkDataResponse aggregateNetworkData(AggregateNetworkDataRequest request)
Gets aggregated network data for given executions.
request
- The request object containing the details to sendBmcException
- 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.
CreateDedicatedVantagePointResponse createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request)
Registers a new dedicated vantage point.
request
- The request object containing the details to sendBmcException
- 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.
CreateMonitorResponse createMonitor(CreateMonitorRequest request)
Creates a new monitor.
request
- The request object containing the details to sendBmcException
- 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.
CreateOnPremiseVantagePointResponse createOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request)
Registers a new On-premise vantage point.
request
- The request object containing the details to sendBmcException
- 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.
CreateScriptResponse createScript(CreateScriptRequest request)
Creates a new script.
request
- The request object containing the details to sendBmcException
- 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.
CreateWorkerResponse createWorker(CreateWorkerRequest request)
Registers a new worker.
request
- The request object containing the details to sendBmcException
- 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.
DeleteDedicatedVantagePointResponse deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request)
Deregisters the specified dedicated vantage point.
request
- The request object containing the details to sendBmcException
- 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.
DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest request)
Deletes the specified monitor.
request
- The request object containing the details to sendBmcException
- 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.
DeleteOnPremiseVantagePointResponse deleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request)
Deregisters the specified On-premise vantage point.
request
- The request object containing the details to sendBmcException
- 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.
DeleteScriptResponse deleteScript(DeleteScriptRequest request)
Deletes the specified script.
request
- The request object containing the details to sendBmcException
- 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.
DeleteWorkerResponse deleteWorker(DeleteWorkerRequest request)
Deregisters the specified worker.
request
- The request object containing the details to sendBmcException
- 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.
GetDedicatedVantagePointResponse getDedicatedVantagePoint(GetDedicatedVantagePointRequest request)
Gets the details of the dedicated vantage point identified by the OCID.
request
- The request object containing the details to sendBmcException
- 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.
GetMonitorResponse getMonitor(GetMonitorRequest request)
Gets the configuration of the monitor identified by the OCID.
request
- The request object containing the details to sendBmcException
- 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.
GetMonitorResultResponse getMonitorResult(GetMonitorResultRequest 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.
request
- The request object containing the details to sendBmcException
- 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.
GetOnPremiseVantagePointResponse getOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request)
Gets the details of the On-premise vantage point identified by the OCID.
request
- The request object containing the details to sendBmcException
- 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.
GetScriptResponse getScript(GetScriptRequest request)
Gets the configuration of the script identified by the OCID.
request
- The request object containing the details to sendBmcException
- 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.
GetWorkerResponse getWorker(GetWorkerRequest request)
Gets the details of the worker identified by the OCID.
request
- The request object containing the details to sendBmcException
- 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.
ListDedicatedVantagePointsResponse listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request)
Returns a list of dedicated vantage points.
request
- The request object containing the details to sendBmcException
- 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.
ListMonitorsResponse listMonitors(ListMonitorsRequest request)
Returns a list of monitors.
request
- The request object containing the details to sendBmcException
- 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.
ListOnPremiseVantagePointsResponse listOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request)
Returns a list of On-premise vantage points.
request
- The request object containing the details to sendBmcException
- 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.
ListPublicVantagePointsResponse listPublicVantagePoints(ListPublicVantagePointsRequest request)
Returns a list of public vantage points.
request
- The request object containing the details to sendBmcException
- 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.
ListScriptsResponse listScripts(ListScriptsRequest request)
Returns a list of scripts.
request
- The request object containing the details to sendBmcException
- 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.
ListWorkersResponse listWorkers(ListWorkersRequest request)
Returns a list of workers.
request
- The request object containing the details to sendBmcException
- 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.
UpdateDedicatedVantagePointResponse updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request)
Updates the dedicated vantage point.
request
- The request object containing the details to sendBmcException
- 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.
UpdateMonitorResponse updateMonitor(UpdateMonitorRequest request)
Updates the monitor.
request
- The request object containing the details to sendBmcException
- 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.
UpdateOnPremiseVantagePointResponse updateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request)
Updates the On-premise vantage point.
request
- The request object containing the details to sendBmcException
- 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.
UpdateScriptResponse updateScript(UpdateScriptRequest request)
Updates the script.
request
- The request object containing the details to sendBmcException
- 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.
UpdateWorkerResponse updateWorker(UpdateWorkerRequest request)
Updates the worker.
request
- The request object containing the details to sendBmcException
- 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.
ApmSyntheticPaginators 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.
Copyright © 2016–2024. All rights reserved.