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

Method Summary

Modifier and Type	Method and Description
ChangeAnalyticsInstanceCompartmentResponse	changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request) Change the compartment of an Analytics instance.
CreateAnalyticsInstanceResponse	createAnalyticsInstance(CreateAnalyticsInstanceRequest request) Create a new AnalyticsInstance in the specified compartment.
DeleteAnalyticsInstanceResponse	deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request) Terminates the specified Analytics instance.
DeleteWorkRequestResponse	deleteWorkRequest(DeleteWorkRequestRequest request) Cancel a work request that has not started yet.
GetAnalyticsInstanceResponse	getAnalyticsInstance(GetAnalyticsInstanceRequest request) Info for a specific Analytics instance.
AnalyticsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
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.
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).
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.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

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

Parameters:

endpoint - The endpoint of the service.

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.