/** * Analytics API * Analytics API. * OpenAPI spec version: 20190331 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); import * as requests from "./request"; import * as model from "./model"; import * as responses from "./response"; import { AnalyticsWaiter } from "./analytics-waiter"; declare const Breaker: any; export declare enum AnalyticsApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class AnalyticsClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": AnalyticsWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * Sets the regionId to call (ex, 'us-phoenix-1'). * * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 * and then call {@link #endpoint(String) endpoint}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new AnalyticsWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): AnalyticsWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): AnalyticsWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Change the compartment of an Analytics instance. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeAnalyticsInstanceCompartmentRequest * @return ChangeAnalyticsInstanceCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ChangeAnalyticsInstanceCompartment.ts.html |here} to see how to use ChangeAnalyticsInstanceCompartment API. */ changeAnalyticsInstanceCompartment(changeAnalyticsInstanceCompartmentRequest: requests.ChangeAnalyticsInstanceCompartmentRequest): Promise; /** * Change an Analytics instance network endpoint. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ChangeAnalyticsInstanceNetworkEndpointRequest * @return ChangeAnalyticsInstanceNetworkEndpointResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ChangeAnalyticsInstanceNetworkEndpoint.ts.html |here} to see how to use ChangeAnalyticsInstanceNetworkEndpoint API. */ changeAnalyticsInstanceNetworkEndpoint(changeAnalyticsInstanceNetworkEndpointRequest: requests.ChangeAnalyticsInstanceNetworkEndpointRequest): Promise; /** * Create a new AnalyticsInstance in the specified compartment. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateAnalyticsInstanceRequest * @return CreateAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/CreateAnalyticsInstance.ts.html |here} to see how to use CreateAnalyticsInstance API. */ createAnalyticsInstance(createAnalyticsInstanceRequest: requests.CreateAnalyticsInstanceRequest): Promise; /** * Create an Private access Channel for the Analytics instance. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreatePrivateAccessChannelRequest * @return CreatePrivateAccessChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/CreatePrivateAccessChannel.ts.html |here} to see how to use CreatePrivateAccessChannel API. */ createPrivateAccessChannel(createPrivateAccessChannelRequest: requests.CreatePrivateAccessChannelRequest): Promise; /** * 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. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param CreateVanityUrlRequest * @return CreateVanityUrlResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/CreateVanityUrl.ts.html |here} to see how to use CreateVanityUrl API. */ createVanityUrl(createVanityUrlRequest: requests.CreateVanityUrlRequest): Promise; /** * Terminates the specified Analytics instance. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteAnalyticsInstanceRequest * @return DeleteAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/DeleteAnalyticsInstance.ts.html |here} to see how to use DeleteAnalyticsInstance API. */ deleteAnalyticsInstance(deleteAnalyticsInstanceRequest: requests.DeleteAnalyticsInstanceRequest): Promise; /** * Delete an Analytics instance's Private access channel with the given unique identifier key. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeletePrivateAccessChannelRequest * @return DeletePrivateAccessChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/DeletePrivateAccessChannel.ts.html |here} to see how to use DeletePrivateAccessChannel API. */ deletePrivateAccessChannel(deletePrivateAccessChannelRequest: requests.DeletePrivateAccessChannelRequest): Promise; /** * Allows deleting a previously created vanity url. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param DeleteVanityUrlRequest * @return DeleteVanityUrlResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/DeleteVanityUrl.ts.html |here} to see how to use DeleteVanityUrl API. */ deleteVanityUrl(deleteVanityUrlRequest: requests.DeleteVanityUrlRequest): Promise; /** * Cancel a work request that has not started yet. * * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteWorkRequestRequest * @return DeleteWorkRequestResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API. */ deleteWorkRequest(deleteWorkRequestRequest: requests.DeleteWorkRequestRequest): Promise; /** * Info for a specific Analytics instance. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetAnalyticsInstanceRequest * @return GetAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/GetAnalyticsInstance.ts.html |here} to see how to use GetAnalyticsInstance API. */ getAnalyticsInstance(getAnalyticsInstanceRequest: requests.GetAnalyticsInstanceRequest): Promise; /** * Retrieve private access channel in the specified Analytics Instance. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetPrivateAccessChannelRequest * @return GetPrivateAccessChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/GetPrivateAccessChannel.ts.html |here} to see how to use GetPrivateAccessChannel API. */ getPrivateAccessChannel(getPrivateAccessChannelRequest: requests.GetPrivateAccessChannelRequest): Promise; /** * Get the details of a work request. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param GetWorkRequestRequest * @return GetWorkRequestResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API. */ getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise; /** * List Analytics instances. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListAnalyticsInstancesRequest * @return ListAnalyticsInstancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ListAnalyticsInstances.ts.html |here} to see how to use ListAnalyticsInstances API. */ listAnalyticsInstances(listAnalyticsInstancesRequest: requests.ListAnalyticsInstancesRequest): Promise; /** * NOTE: This function is deprecated in favor of listAnalyticsInstancesRecordIterator function. * Creates a new async iterator which will iterate over the models.AnalyticsInstanceSummary objects * contained in responses from the listAnalyticsInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllAnalyticsInstances(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listAnalyticsInstancesResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listAnalyticsInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllAnalyticsInstancesResponses(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.AnalyticsInstanceSummary objects * contained in responses from the listAnalyticsInstances operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAnalyticsInstancesRecordIterator(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listAnalyticsInstances operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAnalyticsInstancesResponseIterator(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator; /** * Get the errors of a work request. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListWorkRequestErrorsRequest * @return ListWorkRequestErrorsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API. */ listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestError objects * contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestErrors(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestErrorsResponses(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestError objects * contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestErrorsRecordIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestErrorsResponseIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator; /** * Get the logs of a work request. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListWorkRequestLogsRequest * @return ListWorkRequestLogsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API. */ listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestLog objects * contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestLogs(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestLogsResponses(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestLog objects * contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestLogsRecordIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestLogsResponseIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator; /** * List all work requests in a compartment. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ListWorkRequestsRequest * @return ListWorkRequestsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API. */ listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise; /** * NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. * Creates a new async iterator which will iterate over the models.WorkRequestSummary objects * contained in responses from the listWorkRequests operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequests(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllWorkRequestsResponses(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.WorkRequestSummary objects * contained in responses from the listWorkRequests operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestsRecordIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator; /** * Scale an Analytics instance up or down. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param ScaleAnalyticsInstanceRequest * @return ScaleAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ScaleAnalyticsInstance.ts.html |here} to see how to use ScaleAnalyticsInstance API. */ scaleAnalyticsInstance(scaleAnalyticsInstanceRequest: requests.ScaleAnalyticsInstanceRequest): Promise; /** * Set the external service properties of an Analytics instance. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param SetFeatureBundleRequest * @return SetFeatureBundleResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/SetFeatureBundle.ts.html |here} to see how to use SetFeatureBundle API. */ setFeatureBundle(setFeatureBundleRequest: requests.SetFeatureBundleRequest): Promise; /** * Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param SetKmsKeyRequest * @return SetKmsKeyResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/SetKmsKey.ts.html |here} to see how to use SetKmsKey API. */ setKmsKey(setKmsKeyRequest: requests.SetKmsKeyRequest): Promise; /** * Starts the specified Analytics instance. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param StartAnalyticsInstanceRequest * @return StartAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/StartAnalyticsInstance.ts.html |here} to see how to use StartAnalyticsInstance API. */ startAnalyticsInstance(startAnalyticsInstanceRequest: requests.StartAnalyticsInstanceRequest): Promise; /** * Stop the specified Analytics instance. The operation is long-running * and creates a new WorkRequest. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param StopAnalyticsInstanceRequest * @return StopAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/StopAnalyticsInstance.ts.html |here} to see how to use StopAnalyticsInstance API. */ stopAnalyticsInstance(stopAnalyticsInstanceRequest: requests.StopAnalyticsInstanceRequest): Promise; /** * Updates certain fields of an Analytics instance. Fields that are not provided in the * request will not be updated. * * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateAnalyticsInstanceRequest * @return UpdateAnalyticsInstanceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/UpdateAnalyticsInstance.ts.html |here} to see how to use UpdateAnalyticsInstance API. */ updateAnalyticsInstance(updateAnalyticsInstanceRequest: requests.UpdateAnalyticsInstanceRequest): Promise; /** * Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdatePrivateAccessChannelRequest * @return UpdatePrivateAccessChannelResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/UpdatePrivateAccessChannel.ts.html |here} to see how to use UpdatePrivateAccessChannel API. */ updatePrivateAccessChannel(updatePrivateAccessChannelRequest: requests.UpdatePrivateAccessChannelRequest): Promise; /** * Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring. * * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user. * @param UpdateVanityUrlRequest * @return UpdateVanityUrlResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/UpdateVanityUrl.ts.html |here} to see how to use UpdateVanityUrl API. */ updateVanityUrl(updateVanityUrlRequest: requests.UpdateVanityUrlRequest): Promise; } export {};