java.lang.Object
- com.oracle.bmc.http.internal.BaseAsyncClient
- - com.oracle.bmc.apmsynthetics.ApmSyntheticAsyncClient

All Implemented Interfaces:

ApmSyntheticAsync, AutoCloseable
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class ApmSyntheticAsyncClient
extends BaseAsyncClient
implements ApmSyntheticAsync
```
Async client implementation for ApmSynthetic service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ApmSyntheticAsyncClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for ApmSynthetic.

Constructor Summary

Constructors
Constructor	Description
`ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Future<AggregateNetworkDataResponse>`	`aggregateNetworkData(AggregateNetworkDataRequest request, AsyncHandler<AggregateNetworkDataRequest,AggregateNetworkDataResponse> handler)`	Gets aggregated network data for given executions.
`static ApmSyntheticAsyncClient.Builder`	`builder()`	Create a builder for this client.
`protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>`	`clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)`
`void`	`close()`
`Future<CreateDedicatedVantagePointResponse>`	`createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request, AsyncHandler<CreateDedicatedVantagePointRequest,CreateDedicatedVantagePointResponse> handler)`	Registers a new dedicated vantage point.
`Future<CreateMonitorResponse>`	`createMonitor(CreateMonitorRequest request, AsyncHandler<CreateMonitorRequest,CreateMonitorResponse> handler)`	Creates a new monitor.
`Future<CreateOnPremiseVantagePointResponse>`	`createOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request, AsyncHandler<CreateOnPremiseVantagePointRequest,CreateOnPremiseVantagePointResponse> handler)`	Registers a new On-premise vantage point.
`Future<CreateScriptResponse>`	`createScript(CreateScriptRequest request, AsyncHandler<CreateScriptRequest,CreateScriptResponse> handler)`	Creates a new script.
`Future<CreateWorkerResponse>`	`createWorker(CreateWorkerRequest request, AsyncHandler<CreateWorkerRequest,CreateWorkerResponse> handler)`	Registers a new worker.
`Future<DeleteDedicatedVantagePointResponse>`	`deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request, AsyncHandler<DeleteDedicatedVantagePointRequest,DeleteDedicatedVantagePointResponse> handler)`	Deregisters the specified dedicated vantage point.
`Future<DeleteMonitorResponse>`	`deleteMonitor(DeleteMonitorRequest request, AsyncHandler<DeleteMonitorRequest,DeleteMonitorResponse> handler)`	Deletes the specified monitor.
`Future<DeleteOnPremiseVantagePointResponse>`	`deleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request, AsyncHandler<DeleteOnPremiseVantagePointRequest,DeleteOnPremiseVantagePointResponse> handler)`	Deregisters the specified On-premise vantage point.
`Future<DeleteScriptResponse>`	`deleteScript(DeleteScriptRequest request, AsyncHandler<DeleteScriptRequest,DeleteScriptResponse> handler)`	Deletes the specified script.
`Future<DeleteWorkerResponse>`	`deleteWorker(DeleteWorkerRequest request, AsyncHandler<DeleteWorkerRequest,DeleteWorkerResponse> handler)`	Deregisters the specified worker.
`String`	`getClientCommonLibraryVersion()`
`Future<GetDedicatedVantagePointResponse>`	`getDedicatedVantagePoint(GetDedicatedVantagePointRequest request, AsyncHandler<GetDedicatedVantagePointRequest,GetDedicatedVantagePointResponse> handler)`	Gets the details of the dedicated vantage point identified by the OCID.
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`Future<GetMonitorResponse>`	`getMonitor(GetMonitorRequest request, AsyncHandler<GetMonitorRequest,GetMonitorResponse> handler)`	Gets the configuration of the monitor identified by the OCID.
`Future<GetMonitorResultResponse>`	`getMonitorResult(GetMonitorResultRequest request, AsyncHandler<GetMonitorResultRequest,GetMonitorResultResponse> handler)`	Gets the results for a specific execution of a monitor identified by OCID.
`Future<GetOnPremiseVantagePointResponse>`	`getOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request, AsyncHandler<GetOnPremiseVantagePointRequest,GetOnPremiseVantagePointResponse> handler)`	Gets the details of the On-premise vantage point identified by the OCID.
`Future<GetScriptResponse>`	`getScript(GetScriptRequest request, AsyncHandler<GetScriptRequest,GetScriptResponse> handler)`	Gets the configuration of the script identified by the OCID.
`Future<GetWorkerResponse>`	`getWorker(GetWorkerRequest request, AsyncHandler<GetWorkerRequest,GetWorkerResponse> handler)`	Gets the details of the worker identified by the OCID.
`Future<ListDedicatedVantagePointsResponse>`	`listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request, AsyncHandler<ListDedicatedVantagePointsRequest,ListDedicatedVantagePointsResponse> handler)`	Returns a list of dedicated vantage points.
`Future<ListMonitorsResponse>`	`listMonitors(ListMonitorsRequest request, AsyncHandler<ListMonitorsRequest,ListMonitorsResponse> handler)`	Returns a list of monitors.
`Future<ListOnPremiseVantagePointsResponse>`	`listOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request, AsyncHandler<ListOnPremiseVantagePointsRequest,ListOnPremiseVantagePointsResponse> handler)`	Returns a list of On-premise vantage points.
`Future<ListPublicVantagePointsResponse>`	`listPublicVantagePoints(ListPublicVantagePointsRequest request, AsyncHandler<ListPublicVantagePointsRequest,ListPublicVantagePointsResponse> handler)`	Returns a list of public vantage points.
`Future<ListScriptsResponse>`	`listScripts(ListScriptsRequest request, AsyncHandler<ListScriptsRequest,ListScriptsResponse> handler)`	Returns a list of scripts.
`Future<ListWorkersResponse>`	`listWorkers(ListWorkersRequest request, AsyncHandler<ListWorkersRequest,ListWorkersResponse> handler)`	Returns a list of workers.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`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’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`Future<UpdateDedicatedVantagePointResponse>`	`updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request, AsyncHandler<UpdateDedicatedVantagePointRequest,UpdateDedicatedVantagePointResponse> handler)`	Updates the dedicated vantage point.
`Future<UpdateMonitorResponse>`	`updateMonitor(UpdateMonitorRequest request, AsyncHandler<UpdateMonitorRequest,UpdateMonitorResponse> handler)`	Updates the monitor.
`Future<UpdateOnPremiseVantagePointResponse>`	`updateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request, AsyncHandler<UpdateOnPremiseVantagePointRequest,UpdateOnPremiseVantagePointResponse> handler)`	Updates the On-premise vantage point.
`Future<UpdateScriptResponse>`	`updateScript(UpdateScriptRequest request, AsyncHandler<UpdateScriptRequest,UpdateScriptResponse> handler)`	Updates the script.
`Future<UpdateWorkerResponse>`	`updateWorker(UpdateWorkerRequest request, AsyncHandler<UpdateWorkerRequest,UpdateWorkerResponse> handler)`	Updates the worker.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.apmsynthetics.ApmSyntheticAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable
close

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for ApmSynthetic.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - ApmSyntheticAsyncClient
```
@Deprecated
public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration,
                               ClientConfigurator clientConfigurator,
                               RequestSignerFactory defaultRequestSignerFactory,
                               Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                               List<ClientConfigurator> additionalClientConfigurators,
                               String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see ApmSyntheticAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
- Method Detail
  - builder
```
public static ApmSyntheticAsyncClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: ApmSyntheticAsync
    
    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.
    
    Specified by:
    
    setRegion in interface ApmSyntheticAsync
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: ApmSyntheticAsync
    
    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.
    
    Specified by:
    
    setRegion in interface ApmSyntheticAsync
    
    Parameters:
    
    regionId - The public region ID.
  - aggregateNetworkData
```
public Future<AggregateNetworkDataResponse> aggregateNetworkData(AggregateNetworkDataRequest request,
                                                                 AsyncHandler<AggregateNetworkDataRequest,AggregateNetworkDataResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Gets aggregated network data for given executions.
    
    Specified by:
    
    aggregateNetworkData in interface ApmSyntheticAsync
    
    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.
  - createDedicatedVantagePoint
```
public Future<CreateDedicatedVantagePointResponse> createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request,
                                                                               AsyncHandler<CreateDedicatedVantagePointRequest,CreateDedicatedVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Registers a new dedicated vantage point.
    
    Specified by:
    
    createDedicatedVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<CreateMonitorResponse> createMonitor(CreateMonitorRequest request,
                                                   AsyncHandler<CreateMonitorRequest,CreateMonitorResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Creates a new monitor.
    
    Specified by:
    
    createMonitor in interface ApmSyntheticAsync
    
    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.
  - createOnPremiseVantagePoint
```
public Future<CreateOnPremiseVantagePointResponse> createOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request,
                                                                               AsyncHandler<CreateOnPremiseVantagePointRequest,CreateOnPremiseVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Registers a new On-premise vantage point.
    
    Specified by:
    
    createOnPremiseVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<CreateScriptResponse> createScript(CreateScriptRequest request,
                                                 AsyncHandler<CreateScriptRequest,CreateScriptResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Creates a new script.
    
    Specified by:
    
    createScript in interface ApmSyntheticAsync
    
    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
```
public Future<CreateWorkerResponse> createWorker(CreateWorkerRequest request,
                                                 AsyncHandler<CreateWorkerRequest,CreateWorkerResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Registers a new worker.
    
    Specified by:
    
    createWorker in interface ApmSyntheticAsync
    
    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.
  - deleteDedicatedVantagePoint
```
public Future<DeleteDedicatedVantagePointResponse> deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request,
                                                                               AsyncHandler<DeleteDedicatedVantagePointRequest,DeleteDedicatedVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Deregisters the specified dedicated vantage point.
    
    Specified by:
    
    deleteDedicatedVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<DeleteMonitorResponse> deleteMonitor(DeleteMonitorRequest request,
                                                   AsyncHandler<DeleteMonitorRequest,DeleteMonitorResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Deletes the specified monitor.
    
    Specified by:
    
    deleteMonitor in interface ApmSyntheticAsync
    
    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.
  - deleteOnPremiseVantagePoint
```
public Future<DeleteOnPremiseVantagePointResponse> deleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request,
                                                                               AsyncHandler<DeleteOnPremiseVantagePointRequest,DeleteOnPremiseVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Deregisters the specified On-premise vantage point.
    
    Specified by:
    
    deleteOnPremiseVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<DeleteScriptResponse> deleteScript(DeleteScriptRequest request,
                                                 AsyncHandler<DeleteScriptRequest,DeleteScriptResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Deletes the specified script.
    
    Specified by:
    
    deleteScript in interface ApmSyntheticAsync
    
    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
```
public Future<DeleteWorkerResponse> deleteWorker(DeleteWorkerRequest request,
                                                 AsyncHandler<DeleteWorkerRequest,DeleteWorkerResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Deregisters the specified worker.
    
    Specified by:
    
    deleteWorker in interface ApmSyntheticAsync
    
    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
```
public Future<GetDedicatedVantagePointResponse> getDedicatedVantagePoint(GetDedicatedVantagePointRequest request,
                                                                         AsyncHandler<GetDedicatedVantagePointRequest,GetDedicatedVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Gets the details of the dedicated vantage point identified by the OCID.
    
    Specified by:
    
    getDedicatedVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<GetMonitorResponse> getMonitor(GetMonitorRequest request,
                                             AsyncHandler<GetMonitorRequest,GetMonitorResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Gets the configuration of the monitor identified by the OCID.
    
    Specified by:
    
    getMonitor in interface ApmSyntheticAsync
    
    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
```
public Future<GetMonitorResultResponse> getMonitorResult(GetMonitorResultRequest request,
                                                         AsyncHandler<GetMonitorResultRequest,GetMonitorResultResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    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.
    
    Specified by:
    
    getMonitorResult in interface ApmSyntheticAsync
    
    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
```
public Future<GetOnPremiseVantagePointResponse> getOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request,
                                                                         AsyncHandler<GetOnPremiseVantagePointRequest,GetOnPremiseVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Gets the details of the On-premise vantage point identified by the OCID.
    
    Specified by:
    
    getOnPremiseVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<GetScriptResponse> getScript(GetScriptRequest request,
                                           AsyncHandler<GetScriptRequest,GetScriptResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Gets the configuration of the script identified by the OCID.
    
    Specified by:
    
    getScript in interface ApmSyntheticAsync
    
    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
```
public Future<GetWorkerResponse> getWorker(GetWorkerRequest request,
                                           AsyncHandler<GetWorkerRequest,GetWorkerResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Gets the details of the worker identified by the OCID.
    
    Specified by:
    
    getWorker in interface ApmSyntheticAsync
    
    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.
  - listDedicatedVantagePoints
```
public Future<ListDedicatedVantagePointsResponse> listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request,
                                                                             AsyncHandler<ListDedicatedVantagePointsRequest,ListDedicatedVantagePointsResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Returns a list of dedicated vantage points.
    
    Specified by:
    
    listDedicatedVantagePoints in interface ApmSyntheticAsync
    
    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
```
public Future<ListMonitorsResponse> listMonitors(ListMonitorsRequest request,
                                                 AsyncHandler<ListMonitorsRequest,ListMonitorsResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Returns a list of monitors.
    
    Specified by:
    
    listMonitors in interface ApmSyntheticAsync
    
    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.
  - listOnPremiseVantagePoints
```
public Future<ListOnPremiseVantagePointsResponse> listOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request,
                                                                             AsyncHandler<ListOnPremiseVantagePointsRequest,ListOnPremiseVantagePointsResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Returns a list of On-premise vantage points.
    
    Specified by:
    
    listOnPremiseVantagePoints in interface ApmSyntheticAsync
    
    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.
  - listPublicVantagePoints
```
public Future<ListPublicVantagePointsResponse> listPublicVantagePoints(ListPublicVantagePointsRequest request,
                                                                       AsyncHandler<ListPublicVantagePointsRequest,ListPublicVantagePointsResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Returns a list of public vantage points.
    
    Specified by:
    
    listPublicVantagePoints in interface ApmSyntheticAsync
    
    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
```
public Future<ListScriptsResponse> listScripts(ListScriptsRequest request,
                                               AsyncHandler<ListScriptsRequest,ListScriptsResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Returns a list of scripts.
    
    Specified by:
    
    listScripts in interface ApmSyntheticAsync
    
    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
```
public Future<ListWorkersResponse> listWorkers(ListWorkersRequest request,
                                               AsyncHandler<ListWorkersRequest,ListWorkersResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Returns a list of workers.
    
    Specified by:
    
    listWorkers in interface ApmSyntheticAsync
    
    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.
  - updateDedicatedVantagePoint
```
public Future<UpdateDedicatedVantagePointResponse> updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request,
                                                                               AsyncHandler<UpdateDedicatedVantagePointRequest,UpdateDedicatedVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Updates the dedicated vantage point.
    
    Specified by:
    
    updateDedicatedVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<UpdateMonitorResponse> updateMonitor(UpdateMonitorRequest request,
                                                   AsyncHandler<UpdateMonitorRequest,UpdateMonitorResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Updates the monitor.
    
    Specified by:
    
    updateMonitor in interface ApmSyntheticAsync
    
    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.
  - updateOnPremiseVantagePoint
```
public Future<UpdateOnPremiseVantagePointResponse> updateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request,
                                                                               AsyncHandler<UpdateOnPremiseVantagePointRequest,UpdateOnPremiseVantagePointResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Updates the On-premise vantage point.
    
    Specified by:
    
    updateOnPremiseVantagePoint in interface ApmSyntheticAsync
    
    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
```
public Future<UpdateScriptResponse> updateScript(UpdateScriptRequest request,
                                                 AsyncHandler<UpdateScriptRequest,UpdateScriptResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Updates the script.
    
    Specified by:
    
    updateScript in interface ApmSyntheticAsync
    
    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
```
public Future<UpdateWorkerResponse> updateWorker(UpdateWorkerRequest request,
                                                 AsyncHandler<UpdateWorkerRequest,UpdateWorkerResponse> handler)
```
    Description copied from interface: ApmSyntheticAsync
    
    Updates the worker.
    
    Specified by:
    
    updateWorker in interface ApmSyntheticAsync
    
    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.
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```
  - clientCall
```
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                                                   Supplier<RESP_BUILDER> responseBuilder)
```

Class ApmSyntheticAsyncClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.oracle.bmc.apmsynthetics.ApmSyntheticAsync

Methods inherited from interface java.lang.AutoCloseable

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

ApmSyntheticAsyncClient

ApmSyntheticAsyncClient

ApmSyntheticAsyncClient

ApmSyntheticAsyncClient

ApmSyntheticAsyncClient

ApmSyntheticAsyncClient

ApmSyntheticAsyncClient

Method Detail

builder

setRegion

setRegion

aggregateNetworkData

createDedicatedVantagePoint

createMonitor

createOnPremiseVantagePoint

createScript

createWorker

deleteDedicatedVantagePoint

deleteMonitor

deleteOnPremiseVantagePoint

deleteScript

deleteWorker

getDedicatedVantagePoint

getMonitor

getMonitorResult

getOnPremiseVantagePoint

getScript

getWorker

listDedicatedVantagePoints

listMonitors

listOnPremiseVantagePoints

listPublicVantagePoints

listScripts

listWorkers

updateDedicatedVantagePoint

updateMonitor

updateOnPremiseVantagePoint

updateScript

updateWorker

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient

clientCall