@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.
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).
|
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.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.ChangeAnalyticsInstanceCompartmentResponse changeAnalyticsInstanceCompartment(ChangeAnalyticsInstanceCompartmentRequest request)
Change the compartment of an Analytics instance. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
ChangeAnalyticsInstanceNetworkEndpointResponse changeAnalyticsInstanceNetworkEndpoint(ChangeAnalyticsInstanceNetworkEndpointRequest request)
Change an Analytics instance network endpoint. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
CreateAnalyticsInstanceResponse createAnalyticsInstance(CreateAnalyticsInstanceRequest request)
Create a new AnalyticsInstance in the specified compartment. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
CreatePrivateAccessChannelResponse createPrivateAccessChannel(CreatePrivateAccessChannelRequest request)
Create an Private access Channel for the Analytics instance. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
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.
request
- The request object containing the details to sendBmcException
- 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.
DeleteAnalyticsInstanceResponse deleteAnalyticsInstance(DeleteAnalyticsInstanceRequest request)
Terminates the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
DeletePrivateAccessChannelResponse deletePrivateAccessChannel(DeletePrivateAccessChannelRequest request)
Delete an Analytics instance’s Private access channel with the given unique identifier key.
request
- The request object containing the details to sendBmcException
- 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.
DeleteVanityUrlResponse deleteVanityUrl(DeleteVanityUrlRequest request)
Allows deleting a previously created vanity url.
request
- The request object containing the details to sendBmcException
- 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.
DeleteWorkRequestResponse deleteWorkRequest(DeleteWorkRequestRequest request)
Cancel a work request that has not started yet.
request
- The request object containing the details to sendBmcException
- 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.
GetAnalyticsInstanceResponse getAnalyticsInstance(GetAnalyticsInstanceRequest request)
Info for a specific Analytics instance.
request
- The request object containing the details to sendBmcException
- 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.
GetPrivateAccessChannelResponse getPrivateAccessChannel(GetPrivateAccessChannelRequest request)
Retrieve private access channel in the specified Analytics Instance.
request
- The request object containing the details to sendBmcException
- 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.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Get the details of a work request.
request
- The request object containing the details to sendBmcException
- 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.
ListAnalyticsInstancesResponse listAnalyticsInstances(ListAnalyticsInstancesRequest request)
List Analytics instances.
request
- The request object containing the details to sendBmcException
- 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.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Get the errors of a work request.
request
- The request object containing the details to sendBmcException
- 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.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Get the logs of a work request.
request
- The request object containing the details to sendBmcException
- 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.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
List all work requests in a compartment.
request
- The request object containing the details to sendBmcException
- 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.
ScaleAnalyticsInstanceResponse scaleAnalyticsInstance(ScaleAnalyticsInstanceRequest request)
Scale an Analytics instance up or down. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
SetKmsKeyResponse setKmsKey(SetKmsKeyRequest request)
Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.
request
- The request object containing the details to sendBmcException
- 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.
StartAnalyticsInstanceResponse startAnalyticsInstance(StartAnalyticsInstanceRequest request)
Starts the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
StopAnalyticsInstanceResponse stopAnalyticsInstance(StopAnalyticsInstanceRequest request)
Stop the specified Analytics instance. The operation is long-running and creates a new WorkRequest.
request
- The request object containing the details to sendBmcException
- 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.
UpdateAnalyticsInstanceResponse updateAnalyticsInstance(UpdateAnalyticsInstanceRequest request)
Updates certain fields of an Analytics instance. Fields that are not provided in the request will not be updated.
request
- The request object containing the details to sendBmcException
- 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.
UpdatePrivateAccessChannelResponse updatePrivateAccessChannel(UpdatePrivateAccessChannelRequest request)
Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
request
- The request object containing the details to sendBmcException
- 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.
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.
request
- The request object containing the details to sendBmcException
- 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.
AnalyticsWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2023. All rights reserved.