com.oracle.bmc.analytics

Class AnalyticsAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.analytics.AnalyticsAsyncClient

All Implemented Interfaces:

AnalyticsAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190331")
public class AnalyticsAsyncClient
extends BaseAsyncClient
implements AnalyticsAsync

Async client implementation for Analytics 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 and Description
static class	AnalyticsAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and 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 Analytics.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static AnalyticsAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeAnalyticsInstanceCompartmentResponse>	changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request, AsyncHandler<ChangeAnalyticsInstanceCompartmentRequest,ChangeAnalyticsInstanceCompartmentResponse> handler) Change the compartment of an Analytics instance.
Future<ChangeAnalyticsInstanceNetworkEndpointResponse>	changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request, AsyncHandler<ChangeAnalyticsInstanceNetworkEndpointRequest,ChangeAnalyticsInstanceNetworkEndpointResponse> handler) Change an Analytics instance network endpoint.
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<CreateAnalyticsInstanceResponse>	createAnalyticsInstance(CreateAnalyticsInstanceRequest request, AsyncHandler<CreateAnalyticsInstanceRequest,CreateAnalyticsInstanceResponse> handler) Create a new AnalyticsInstance in the specified compartment.
Future<CreatePrivateAccessChannelResponse>	createPrivateAccessChannel(CreatePrivateAccessChannelRequest request, AsyncHandler<CreatePrivateAccessChannelRequest,CreatePrivateAccessChannelResponse> handler) Create an Private access Channel for the Analytics instance.
Future<CreateVanityUrlResponse>	createVanityUrl(CreateVanityUrlRequest request, AsyncHandler<CreateVanityUrlRequest,CreateVanityUrlResponse> handler) Allows specifying a custom host name to be used to access the analytics instance.
Future<DeleteAnalyticsInstanceResponse>	deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request, AsyncHandler<DeleteAnalyticsInstanceRequest,DeleteAnalyticsInstanceResponse> handler) Terminates the specified Analytics instance.
Future<DeletePrivateAccessChannelResponse>	deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request, AsyncHandler<DeletePrivateAccessChannelRequest,DeletePrivateAccessChannelResponse> handler) Delete an Analytics instance’s Private access channel with the given unique identifier key.
Future<DeleteVanityUrlResponse>	deleteVanityUrl(DeleteVanityUrlRequest request, AsyncHandler<DeleteVanityUrlRequest,DeleteVanityUrlResponse> handler) Allows deleting a previously created vanity url.
Future<DeleteWorkRequestResponse>	deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler) Cancel a work request that has not started yet.
Future<GetAnalyticsInstanceResponse>	getAnalyticsInstance(GetAnalyticsInstanceRequest request, AsyncHandler<GetAnalyticsInstanceRequest,GetAnalyticsInstanceResponse> handler) Info for a specific Analytics instance.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetPrivateAccessChannelResponse>	getPrivateAccessChannel(GetPrivateAccessChannelRequest request, AsyncHandler<GetPrivateAccessChannelRequest,GetPrivateAccessChannelResponse> handler) Retrieve private access channel in the specified Analytics Instance.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Get the details of a work request.
Future<ListAnalyticsInstancesResponse>	listAnalyticsInstances(ListAnalyticsInstancesRequest request, AsyncHandler<ListAnalyticsInstancesRequest,ListAnalyticsInstancesResponse> handler) List Analytics instances.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Get the errors of a work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Get the logs of a work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) List all work requests in a compartment.
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.
Future<ScaleAnalyticsInstanceResponse>	scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request, AsyncHandler<ScaleAnalyticsInstanceRequest,ScaleAnalyticsInstanceResponse> handler) Scale an Analytics instance up or down.
void	setEndpoint(String endpoint)
Future<SetFeatureBundleResponse>	setFeatureBundle(SetFeatureBundleRequest request, AsyncHandler<SetFeatureBundleRequest,SetFeatureBundleResponse> handler) Set the external service properties of an Analytics instance.
Future<SetKmsKeyResponse>	setKmsKey(SetKmsKeyRequest request, AsyncHandler<SetKmsKeyRequest,SetKmsKeyResponse> handler) Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.
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’).
Future<StartAnalyticsInstanceResponse>	startAnalyticsInstance(StartAnalyticsInstanceRequest request, AsyncHandler<StartAnalyticsInstanceRequest,StartAnalyticsInstanceResponse> handler) Starts the specified Analytics instance.
Future<StopAnalyticsInstanceResponse>	stopAnalyticsInstance(StopAnalyticsInstanceRequest request, AsyncHandler<StopAnalyticsInstanceRequest,StopAnalyticsInstanceResponse> handler) Stop the specified Analytics instance.
Future<UpdateAnalyticsInstanceResponse>	updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request, AsyncHandler<UpdateAnalyticsInstanceRequest,UpdateAnalyticsInstanceResponse> handler) Updates certain fields of an Analytics instance.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdatePrivateAccessChannelResponse>	updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request, AsyncHandler<UpdatePrivateAccessChannelRequest,UpdatePrivateAccessChannelResponse> handler) Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
Future<UpdateVanityUrlResponse>	updateVanityUrl(UpdateVanityUrlRequest request, AsyncHandler<UpdateVanityUrlRequest,UpdateVanityUrlResponse> handler) Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
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.analytics.AnalyticsAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Analytics.

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

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                        ClientConfiguration configuration,
                                        ClientConfigurator clientConfigurator,
                                        RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see AnalyticsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(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 AnalyticsAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(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 AnalyticsAsyncClient.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)

AnalyticsAsyncClient

@Deprecated
public AnalyticsAsyncClient(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 AnalyticsAsyncClient.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 AnalyticsAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: AnalyticsAsync

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 AnalyticsAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: AnalyticsAsync

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 AnalyticsAsync

Parameters:

regionId - The public region ID.

changeAnalyticsInstanceCompartment

public Future<ChangeAnalyticsInstanceCompartmentResponse> changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request,
                                                                                             AsyncHandler<ChangeAnalyticsInstanceCompartmentRequest,ChangeAnalyticsInstanceCompartmentResponse> handler)

Description copied from interface: AnalyticsAsync

Change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest.

Specified by:

changeAnalyticsInstanceCompartment in interface AnalyticsAsync

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.

changeAnalyticsInstanceNetworkEndpoint

public Future<ChangeAnalyticsInstanceNetworkEndpointResponse> changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request,
                                                                                                     AsyncHandler<ChangeAnalyticsInstanceNetworkEndpointRequest,ChangeAnalyticsInstanceNetworkEndpointResponse> handler)

Description copied from interface: AnalyticsAsync

Change an Analytics instance network endpoint. The operation is long-running and creates a new WorkRequest.

Specified by:

changeAnalyticsInstanceNetworkEndpoint in interface AnalyticsAsync

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.

createAnalyticsInstance

public Future<CreateAnalyticsInstanceResponse> createAnalyticsInstance(CreateAnalyticsInstanceRequest request,
                                                                       AsyncHandler<CreateAnalyticsInstanceRequest,CreateAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.

Specified by:

createAnalyticsInstance in interface AnalyticsAsync

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.

createPrivateAccessChannel

public Future<CreatePrivateAccessChannelResponse> createPrivateAccessChannel(CreatePrivateAccessChannelRequest request,
                                                                             AsyncHandler<CreatePrivateAccessChannelRequest,CreatePrivateAccessChannelResponse> handler)

Description copied from interface: AnalyticsAsync

Create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.

Specified by:

createPrivateAccessChannel in interface AnalyticsAsync

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.

createVanityUrl

public Future<CreateVanityUrlResponse> createVanityUrl(CreateVanityUrlRequest request,
                                                       AsyncHandler<CreateVanityUrlRequest,CreateVanityUrlResponse> handler)

Description copied from interface: AnalyticsAsync

Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate for this host.

Specified by:

createVanityUrl in interface AnalyticsAsync

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.

deleteAnalyticsInstance

public Future<DeleteAnalyticsInstanceResponse> deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request,
                                                                       AsyncHandler<DeleteAnalyticsInstanceRequest,DeleteAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

Specified by:

deleteAnalyticsInstance in interface AnalyticsAsync

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.

deletePrivateAccessChannel

public Future<DeletePrivateAccessChannelResponse> deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request,
                                                                             AsyncHandler<DeletePrivateAccessChannelRequest,DeletePrivateAccessChannelResponse> handler)

Description copied from interface: AnalyticsAsync

Delete an Analytics instance’s Private access channel with the given unique identifier key.

Specified by:

deletePrivateAccessChannel in interface AnalyticsAsync

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.

deleteVanityUrl

public Future<DeleteVanityUrlResponse> deleteVanityUrl(DeleteVanityUrlRequest request,
                                                       AsyncHandler<DeleteVanityUrlRequest,DeleteVanityUrlResponse> handler)

Description copied from interface: AnalyticsAsync

Allows deleting a previously created vanity url.

Specified by:

deleteVanityUrl in interface AnalyticsAsync

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.

deleteWorkRequest

public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                           AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)

Description copied from interface: AnalyticsAsync

Cancel a work request that has not started yet.

Specified by:

deleteWorkRequest in interface AnalyticsAsync

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.

getAnalyticsInstance

public Future<GetAnalyticsInstanceResponse> getAnalyticsInstance(GetAnalyticsInstanceRequest request,
                                                                 AsyncHandler<GetAnalyticsInstanceRequest,GetAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Info for a specific Analytics instance.

Specified by:

getAnalyticsInstance in interface AnalyticsAsync

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.

getPrivateAccessChannel

public Future<GetPrivateAccessChannelResponse> getPrivateAccessChannel(GetPrivateAccessChannelRequest request,
                                                                       AsyncHandler<GetPrivateAccessChannelRequest,GetPrivateAccessChannelResponse> handler)

Description copied from interface: AnalyticsAsync

Retrieve private access channel in the specified Analytics Instance.

Specified by:

getPrivateAccessChannel in interface AnalyticsAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: AnalyticsAsync

Get the details of a work request.

Specified by:

getWorkRequest in interface AnalyticsAsync

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.

listAnalyticsInstances

public Future<ListAnalyticsInstancesResponse> listAnalyticsInstances(ListAnalyticsInstancesRequest request,
                                                                     AsyncHandler<ListAnalyticsInstancesRequest,ListAnalyticsInstancesResponse> handler)

Description copied from interface: AnalyticsAsync

List Analytics instances.

Specified by:

listAnalyticsInstances in interface AnalyticsAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: AnalyticsAsync

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface AnalyticsAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: AnalyticsAsync

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface AnalyticsAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: AnalyticsAsync

List all work requests in a compartment.

Specified by:

listWorkRequests in interface AnalyticsAsync

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.

scaleAnalyticsInstance

public Future<ScaleAnalyticsInstanceResponse> scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request,
                                                                     AsyncHandler<ScaleAnalyticsInstanceRequest,ScaleAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.

Specified by:

scaleAnalyticsInstance in interface AnalyticsAsync

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.

setFeatureBundle

public Future<SetFeatureBundleResponse> setFeatureBundle(SetFeatureBundleRequest request,
                                                         AsyncHandler<SetFeatureBundleRequest,SetFeatureBundleResponse> handler)

Description copied from interface: AnalyticsAsync

Set the external service properties of an Analytics instance.

Specified by:

setFeatureBundle in interface AnalyticsAsync

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.

setKmsKey

public Future<SetKmsKeyResponse> setKmsKey(SetKmsKeyRequest request,
                                           AsyncHandler<SetKmsKeyRequest,SetKmsKeyResponse> handler)

Description copied from interface: AnalyticsAsync

Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.

Specified by:

setKmsKey in interface AnalyticsAsync

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.

startAnalyticsInstance

public Future<StartAnalyticsInstanceResponse> startAnalyticsInstance(StartAnalyticsInstanceRequest request,
                                                                     AsyncHandler<StartAnalyticsInstanceRequest,StartAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

Specified by:

startAnalyticsInstance in interface AnalyticsAsync

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.

stopAnalyticsInstance

public Future<StopAnalyticsInstanceResponse> stopAnalyticsInstance(StopAnalyticsInstanceRequest request,
                                                                   AsyncHandler<StopAnalyticsInstanceRequest,StopAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.

Specified by:

stopAnalyticsInstance in interface AnalyticsAsync

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.

updateAnalyticsInstance

public Future<UpdateAnalyticsInstanceResponse> updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request,
                                                                       AsyncHandler<UpdateAnalyticsInstanceRequest,UpdateAnalyticsInstanceResponse> handler)

Description copied from interface: AnalyticsAsync

Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.

Specified by:

updateAnalyticsInstance in interface AnalyticsAsync

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.

updatePrivateAccessChannel

public Future<UpdatePrivateAccessChannelResponse> updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request,
                                                                             AsyncHandler<UpdatePrivateAccessChannelRequest,UpdatePrivateAccessChannelResponse> handler)

Description copied from interface: AnalyticsAsync

Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.

Specified by:

updatePrivateAccessChannel in interface AnalyticsAsync

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.

updateVanityUrl

public Future<UpdateVanityUrlResponse> updateVanityUrl(UpdateVanityUrlRequest request,
                                                       AsyncHandler<UpdateVanityUrlRequest,UpdateVanityUrlResponse> handler)

Description copied from interface: AnalyticsAsync

Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.

Specified by:

updateVanityUrl in interface AnalyticsAsync

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)