com.oracle.bmc.analytics

Interface AnalyticsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AnalyticsAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190331")
public interface AnalyticsAsync
extends AutoCloseable

Analytics API.

Method Summary

Modifier and Type	Method and Description
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.
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	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
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	refreshClient() Rebuilds the client from scratch.
Future<ScaleAnalyticsInstanceResponse>	scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request, AsyncHandler<ScaleAnalyticsInstanceRequest,ScaleAnalyticsInstanceResponse> handler) Scale an Analytics instance up or down.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
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.
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.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

changeAnalyticsInstanceCompartment

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

Allows deleting a previously created vanity url.

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

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

Cancel a work request that has not started yet.

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

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

Info for a specific Analytics instance.

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

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

Retrieve private access channel in the specified Analytics Instance.

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

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

Get the details of a work request.

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

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

List Analytics instances.

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

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

Get the errors of a work request.

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

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

Get the logs of a work request.

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

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

List all work requests in a compartment.

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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.

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

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.

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.