com.oracle.bmc.analytics

Interface Analytics

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AnalyticsClient

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

Analytics API.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
ChangeAnalyticsInstanceCompartmentResponse	changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request) Change the compartment of an Analytics instance.
ChangeAnalyticsInstanceNetworkEndpointResponse	changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request) Change an Analytics instance network endpoint.
CreateAnalyticsInstanceResponse	createAnalyticsInstance(CreateAnalyticsInstanceRequest request) Create a new AnalyticsInstance in the specified compartment.
CreatePrivateAccessChannelResponse	createPrivateAccessChannel(CreatePrivateAccessChannelRequest request) Create an Private access Channel for the Analytics instance.
CreateVanityUrlResponse	createVanityUrl(CreateVanityUrlRequest request) Allows specifying a custom host name to be used to access the analytics instance.
DeleteAnalyticsInstanceResponse	deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request) Terminates the specified Analytics instance.
DeletePrivateAccessChannelResponse	deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request) Delete an Analytics instance’s Private access channel with the given unique identifier key.
DeleteVanityUrlResponse	deleteVanityUrl(DeleteVanityUrlRequest request) Allows deleting a previously created vanity url.
DeleteWorkRequestResponse	deleteWorkRequest(DeleteWorkRequestRequest request) Cancel a work request that has not started yet.
GetAnalyticsInstanceResponse	getAnalyticsInstance(GetAnalyticsInstanceRequest request) Info for a specific Analytics instance.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
AnalyticsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPrivateAccessChannelResponse	getPrivateAccessChannel(GetPrivateAccessChannelRequest request) Retrieve private access channel in the specified Analytics Instance.
AnalyticsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Get the details of a work request.
ListAnalyticsInstancesResponse	listAnalyticsInstances(ListAnalyticsInstancesRequest request) List Analytics instances.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Get the errors of a work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Get the logs of a work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) List all work requests in a compartment.
void	refreshClient() Rebuilds the client from scratch.
ScaleAnalyticsInstanceResponse	scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request) Scale an Analytics instance up or down.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
SetFeatureBundleResponse	setFeatureBundle(SetFeatureBundleRequest request) Set the external service properties of an Analytics instance.
SetKmsKeyResponse	setKmsKey(SetKmsKeyRequest request) 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’).
StartAnalyticsInstanceResponse	startAnalyticsInstance(StartAnalyticsInstanceRequest request) Starts the specified Analytics instance.
StopAnalyticsInstanceResponse	stopAnalyticsInstance(StopAnalyticsInstanceRequest request) Stop the specified Analytics instance.
UpdateAnalyticsInstanceResponse	updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request) Updates certain fields of an Analytics instance.
UpdatePrivateAccessChannelResponse	updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request) Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
UpdateVanityUrlResponse	updateVanityUrl(UpdateVanityUrlRequest request) Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

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 service.

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.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

changeAnalyticsInstanceCompartment

ChangeAnalyticsInstanceCompartmentResponse changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ChangeAnalyticsInstanceCompartment API.

changeAnalyticsInstanceNetworkEndpoint

ChangeAnalyticsInstanceNetworkEndpointResponse changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ChangeAnalyticsInstanceNetworkEndpoint API.

createAnalyticsInstance

CreateAnalyticsInstanceResponse createAnalyticsInstance(CreateAnalyticsInstanceRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateAnalyticsInstance API.

createPrivateAccessChannel

CreatePrivateAccessChannelResponse createPrivateAccessChannel(CreatePrivateAccessChannelRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreatePrivateAccessChannel API.

createVanityUrl

CreateVanityUrlResponse createVanityUrl(CreateVanityUrlRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateVanityUrl API.

deleteAnalyticsInstance

DeleteAnalyticsInstanceResponse deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteAnalyticsInstance API.

deletePrivateAccessChannel

DeletePrivateAccessChannelResponse deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeletePrivateAccessChannel API.

deleteVanityUrl

DeleteVanityUrlResponse deleteVanityUrl(DeleteVanityUrlRequest request)

Allows deleting a previously created vanity url.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteVanityUrl API.

deleteWorkRequest

DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)

Cancel a work request that has not started yet.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteWorkRequest API.

getAnalyticsInstance

GetAnalyticsInstanceResponse getAnalyticsInstance(GetAnalyticsInstanceRequest request)

Info for a specific Analytics instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetAnalyticsInstance API.

getPrivateAccessChannel

GetPrivateAccessChannelResponse getPrivateAccessChannel(GetPrivateAccessChannelRequest request)

Retrieve private access channel in the specified Analytics Instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetPrivateAccessChannel API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Get the details of a work request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetWorkRequest API.

listAnalyticsInstances

ListAnalyticsInstancesResponse listAnalyticsInstances(ListAnalyticsInstancesRequest request)

List Analytics instances.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListAnalyticsInstances API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Get the errors of a work request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Get the logs of a work request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

List all work requests in a compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListWorkRequests API.

scaleAnalyticsInstance

ScaleAnalyticsInstanceResponse scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ScaleAnalyticsInstance API.

setFeatureBundle

SetFeatureBundleResponse setFeatureBundle(SetFeatureBundleRequest request)

Set the external service properties of an Analytics instance.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SetFeatureBundle API.

setKmsKey

SetKmsKeyResponse setKmsKey(SetKmsKeyRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use SetKmsKey API.

startAnalyticsInstance

StartAnalyticsInstanceResponse startAnalyticsInstance(StartAnalyticsInstanceRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use StartAnalyticsInstance API.

stopAnalyticsInstance

StopAnalyticsInstanceResponse stopAnalyticsInstance(StopAnalyticsInstanceRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use StopAnalyticsInstance API.

updateAnalyticsInstance

UpdateAnalyticsInstanceResponse updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateAnalyticsInstance API.

updatePrivateAccessChannel

UpdatePrivateAccessChannelResponse updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdatePrivateAccessChannel API.

updateVanityUrl

UpdateVanityUrlResponse updateVanityUrl(UpdateVanityUrlRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateVanityUrl API.

getWaiters

AnalyticsWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

AnalyticsPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.