@Generated(value="OracleSDKGenerator", comments="API Version: 20200630") public class ApmSyntheticAsyncClient extends Object implements ApmSyntheticAsync
Async client implementation for ApmSynthetic service.
There are two ways to use async client:
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. Modifier and Type | Class and Description |
---|---|
static class |
ApmSyntheticAsyncClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for ApmSynthetic.
|
Constructor and Description |
---|
ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for ApmSynthetic.
public ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public ApmSyntheticAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public ApmSyntheticAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)restClientFactoryBuilder
- the builder for the RestClientFactory
public static ApmSyntheticAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
ApmSyntheticAsync
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface ApmSyntheticAsync
endpoint
- The endpoint of the serice.public String getEndpoint()
ApmSyntheticAsync
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface ApmSyntheticAsync
public void setRegion(Region region)
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.
setRegion
in interface ApmSyntheticAsync
region
- The region of the service.public void setRegion(String regionId)
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
.
setRegion
in interface ApmSyntheticAsync
regionId
- The public region ID.public void close()
close
in interface AutoCloseable
public Future<CreateDedicatedVantagePointResponse> createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request, AsyncHandler<CreateDedicatedVantagePointRequest,CreateDedicatedVantagePointResponse> handler)
ApmSyntheticAsync
Registers a new dedicated vantage point.
createDedicatedVantagePoint
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateMonitorResponse> createMonitor(CreateMonitorRequest request, AsyncHandler<CreateMonitorRequest,CreateMonitorResponse> handler)
ApmSyntheticAsync
Creates a new monitor.
createMonitor
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<CreateScriptResponse> createScript(CreateScriptRequest request, AsyncHandler<CreateScriptRequest,CreateScriptResponse> handler)
ApmSyntheticAsync
Creates a new script.
createScript
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteDedicatedVantagePointResponse> deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request, AsyncHandler<DeleteDedicatedVantagePointRequest,DeleteDedicatedVantagePointResponse> handler)
ApmSyntheticAsync
Deregisters the specified dedicated vantage point.
deleteDedicatedVantagePoint
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteMonitorResponse> deleteMonitor(DeleteMonitorRequest request, AsyncHandler<DeleteMonitorRequest,DeleteMonitorResponse> handler)
ApmSyntheticAsync
Deletes the specified monitor.
deleteMonitor
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<DeleteScriptResponse> deleteScript(DeleteScriptRequest request, AsyncHandler<DeleteScriptRequest,DeleteScriptResponse> handler)
ApmSyntheticAsync
Deletes the specified script.
deleteScript
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetDedicatedVantagePointResponse> getDedicatedVantagePoint(GetDedicatedVantagePointRequest request, AsyncHandler<GetDedicatedVantagePointRequest,GetDedicatedVantagePointResponse> handler)
ApmSyntheticAsync
Gets the details of the dedicated vantage point identified by the OCID.
getDedicatedVantagePoint
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetMonitorResponse> getMonitor(GetMonitorRequest request, AsyncHandler<GetMonitorRequest,GetMonitorResponse> handler)
ApmSyntheticAsync
Gets the configuration of the monitor identified by the OCID.
getMonitor
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetMonitorResultResponse> getMonitorResult(GetMonitorResultRequest request, AsyncHandler<GetMonitorResultRequest,GetMonitorResultResponse> handler)
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.
getMonitorResult
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<GetScriptResponse> getScript(GetScriptRequest request, AsyncHandler<GetScriptRequest,GetScriptResponse> handler)
ApmSyntheticAsync
Gets the configuration of the script identified by the OCID.
getScript
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListDedicatedVantagePointsResponse> listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request, AsyncHandler<ListDedicatedVantagePointsRequest,ListDedicatedVantagePointsResponse> handler)
ApmSyntheticAsync
Returns a list of dedicated vantage points.
listDedicatedVantagePoints
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListMonitorsResponse> listMonitors(ListMonitorsRequest request, AsyncHandler<ListMonitorsRequest,ListMonitorsResponse> handler)
ApmSyntheticAsync
Returns a list of monitors.
listMonitors
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListPublicVantagePointsResponse> listPublicVantagePoints(ListPublicVantagePointsRequest request, AsyncHandler<ListPublicVantagePointsRequest,ListPublicVantagePointsResponse> handler)
ApmSyntheticAsync
Returns a list of public vantage points.
listPublicVantagePoints
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<ListScriptsResponse> listScripts(ListScriptsRequest request, AsyncHandler<ListScriptsRequest,ListScriptsResponse> handler)
ApmSyntheticAsync
Returns a list of scripts.
listScripts
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateDedicatedVantagePointResponse> updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request, AsyncHandler<UpdateDedicatedVantagePointRequest,UpdateDedicatedVantagePointResponse> handler)
ApmSyntheticAsync
Updates the dedicated vantage point.
updateDedicatedVantagePoint
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateMonitorResponse> updateMonitor(UpdateMonitorRequest request, AsyncHandler<UpdateMonitorRequest,UpdateMonitorResponse> handler)
ApmSyntheticAsync
Updates the monitor.
updateMonitor
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.public Future<UpdateScriptResponse> updateScript(UpdateScriptRequest request, AsyncHandler<UpdateScriptRequest,UpdateScriptResponse> handler)
ApmSyntheticAsync
Updates the script.
updateScript
in interface ApmSyntheticAsync
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.