oci-analytics 2.5.2 → 2.6.0

package/lib/client.d.ts

@@ -18,6 +18,9 @@ import * as responses from "./response";
 import { AnalyticsWaiter } from "./analytics-waiter";
 export declare enum AnalyticsApiKeys {
 }
+/**
+ * This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
+ */
 export declare class AnalyticsClient {
     protected static serviceEndpointTemplate: string;
     protected "_endpoint": string;
@@ -69,123 +72,136 @@ export declare class AnalyticsClient {
      * Change the compartment of an Analytics instance. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeAnalyticsInstanceCompartmentRequest
      * @return ChangeAnalyticsInstanceCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ChangeAnalyticsInstanceCompartment.ts.html |here} to see how to use ChangeAnalyticsInstanceCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ChangeAnalyticsInstanceCompartment.ts.html |here} to see how to use ChangeAnalyticsInstanceCompartment API.
      */
     changeAnalyticsInstanceCompartment(changeAnalyticsInstanceCompartmentRequest: requests.ChangeAnalyticsInstanceCompartmentRequest): Promise<responses.ChangeAnalyticsInstanceCompartmentResponse>;
     /**
      * Change an Analytics instance network endpoint. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ChangeAnalyticsInstanceNetworkEndpointRequest
      * @return ChangeAnalyticsInstanceNetworkEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ChangeAnalyticsInstanceNetworkEndpoint.ts.html |here} to see how to use ChangeAnalyticsInstanceNetworkEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ChangeAnalyticsInstanceNetworkEndpoint.ts.html |here} to see how to use ChangeAnalyticsInstanceNetworkEndpoint API.
      */
     changeAnalyticsInstanceNetworkEndpoint(changeAnalyticsInstanceNetworkEndpointRequest: requests.ChangeAnalyticsInstanceNetworkEndpointRequest): Promise<responses.ChangeAnalyticsInstanceNetworkEndpointResponse>;
     /**
      * Create a new AnalyticsInstance in the specified compartment. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateAnalyticsInstanceRequest
      * @return CreateAnalyticsInstanceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/CreateAnalyticsInstance.ts.html |here} to see how to use CreateAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/CreateAnalyticsInstance.ts.html |here} to see how to use CreateAnalyticsInstance API.
      */
     createAnalyticsInstance(createAnalyticsInstanceRequest: requests.CreateAnalyticsInstanceRequest): Promise<responses.CreateAnalyticsInstanceResponse>;
     /**
      * Create an Private access Channel for the Analytics instance. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreatePrivateAccessChannelRequest
      * @return CreatePrivateAccessChannelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/CreatePrivateAccessChannel.ts.html |here} to see how to use CreatePrivateAccessChannel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/CreatePrivateAccessChannel.ts.html |here} to see how to use CreatePrivateAccessChannel API.
      */
     createPrivateAccessChannel(createPrivateAccessChannelRequest: requests.CreatePrivateAccessChannelRequest): Promise<responses.CreatePrivateAccessChannelResponse>;
     /**
      * 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 does not retry by default if the user has not defined a retry configuration.
      * @param CreateVanityUrlRequest
      * @return CreateVanityUrlResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/CreateVanityUrl.ts.html |here} to see how to use CreateVanityUrl API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/CreateVanityUrl.ts.html |here} to see how to use CreateVanityUrl API.
      */
     createVanityUrl(createVanityUrlRequest: requests.CreateVanityUrlRequest): Promise<responses.CreateVanityUrlResponse>;
     /**
      * Terminates the specified Analytics instance. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteAnalyticsInstanceRequest
      * @return DeleteAnalyticsInstanceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/DeleteAnalyticsInstance.ts.html |here} to see how to use DeleteAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeleteAnalyticsInstance.ts.html |here} to see how to use DeleteAnalyticsInstance API.
      */
     deleteAnalyticsInstance(deleteAnalyticsInstanceRequest: requests.DeleteAnalyticsInstanceRequest): Promise<responses.DeleteAnalyticsInstanceResponse>;
     /**
      * Delete an Analytics instance's Private access channel with the given unique identifier key.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeletePrivateAccessChannelRequest
      * @return DeletePrivateAccessChannelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/DeletePrivateAccessChannel.ts.html |here} to see how to use DeletePrivateAccessChannel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeletePrivateAccessChannel.ts.html |here} to see how to use DeletePrivateAccessChannel API.
      */
     deletePrivateAccessChannel(deletePrivateAccessChannelRequest: requests.DeletePrivateAccessChannelRequest): Promise<responses.DeletePrivateAccessChannelResponse>;
     /**
      * Allows deleting a previously created vanity url.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteVanityUrlRequest
      * @return DeleteVanityUrlResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/DeleteVanityUrl.ts.html |here} to see how to use DeleteVanityUrl API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeleteVanityUrl.ts.html |here} to see how to use DeleteVanityUrl API.
      */
     deleteVanityUrl(deleteVanityUrlRequest: requests.DeleteVanityUrlRequest): Promise<responses.DeleteVanityUrlResponse>;
     /**
      * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
      */
     deleteWorkRequest(deleteWorkRequestRequest: requests.DeleteWorkRequestRequest): Promise<responses.DeleteWorkRequestResponse>;
     /**
      * Info for a specific Analytics instance.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetAnalyticsInstanceRequest
      * @return GetAnalyticsInstanceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/GetAnalyticsInstance.ts.html |here} to see how to use GetAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/GetAnalyticsInstance.ts.html |here} to see how to use GetAnalyticsInstance API.
      */
     getAnalyticsInstance(getAnalyticsInstanceRequest: requests.GetAnalyticsInstanceRequest): Promise<responses.GetAnalyticsInstanceResponse>;
     /**
      * Retrieve private access channel in the specified Analytics Instance.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetPrivateAccessChannelRequest
      * @return GetPrivateAccessChannelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/GetPrivateAccessChannel.ts.html |here} to see how to use GetPrivateAccessChannel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/GetPrivateAccessChannel.ts.html |here} to see how to use GetPrivateAccessChannel API.
      */
     getPrivateAccessChannel(getPrivateAccessChannelRequest: requests.GetPrivateAccessChannelRequest): Promise<responses.GetPrivateAccessChannelResponse>;
     /**
      * Get the details of a work request.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param GetWorkRequestRequest
      * @return GetWorkRequestResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
      * List Analytics instances.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListAnalyticsInstancesRequest
      * @return ListAnalyticsInstancesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ListAnalyticsInstances.ts.html |here} to see how to use ListAnalyticsInstances API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListAnalyticsInstances.ts.html |here} to see how to use ListAnalyticsInstances API.
      */
     listAnalyticsInstances(listAnalyticsInstancesRequest: requests.ListAnalyticsInstancesRequest): Promise<responses.ListAnalyticsInstancesResponse>;
     /**
@@ -223,10 +239,11 @@ export declare class AnalyticsClient {
     /**
      * Get the errors of a work request.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestErrorsRequest
      * @return ListWorkRequestErrorsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
      */
     listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
     /**
@@ -264,10 +281,11 @@ export declare class AnalyticsClient {
     /**
      * Get the logs of a work request.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestLogsRequest
      * @return ListWorkRequestLogsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
      */
     listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
     /**
@@ -305,10 +323,11 @@ export declare class AnalyticsClient {
     /**
      * List all work requests in a compartment.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ListWorkRequestsRequest
      * @return ListWorkRequestsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
@@ -347,58 +366,64 @@ export declare class AnalyticsClient {
      * Scale an Analytics instance up or down. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ScaleAnalyticsInstanceRequest
      * @return ScaleAnalyticsInstanceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/ScaleAnalyticsInstance.ts.html |here} to see how to use ScaleAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ScaleAnalyticsInstance.ts.html |here} to see how to use ScaleAnalyticsInstance API.
      */
     scaleAnalyticsInstance(scaleAnalyticsInstanceRequest: requests.ScaleAnalyticsInstanceRequest): Promise<responses.ScaleAnalyticsInstanceResponse>;
     /**
      * Starts the specified Analytics instance. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param StartAnalyticsInstanceRequest
      * @return StartAnalyticsInstanceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/StartAnalyticsInstance.ts.html |here} to see how to use StartAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/StartAnalyticsInstance.ts.html |here} to see how to use StartAnalyticsInstance API.
      */
     startAnalyticsInstance(startAnalyticsInstanceRequest: requests.StartAnalyticsInstanceRequest): Promise<responses.StartAnalyticsInstanceResponse>;
     /**
      * Stop the specified Analytics instance. The operation is long-running
      * and creates a new WorkRequest.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param StopAnalyticsInstanceRequest
      * @return StopAnalyticsInstanceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/StopAnalyticsInstance.ts.html |here} to see how to use StopAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/StopAnalyticsInstance.ts.html |here} to see how to use StopAnalyticsInstance API.
      */
     stopAnalyticsInstance(stopAnalyticsInstanceRequest: requests.StopAnalyticsInstanceRequest): Promise<responses.StopAnalyticsInstanceResponse>;
     /**
      * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/UpdateAnalyticsInstance.ts.html |here} to see how to use UpdateAnalyticsInstance API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/UpdateAnalyticsInstance.ts.html |here} to see how to use UpdateAnalyticsInstance API.
      */
     updateAnalyticsInstance(updateAnalyticsInstanceRequest: requests.UpdateAnalyticsInstanceRequest): Promise<responses.UpdateAnalyticsInstanceResponse>;
     /**
      * Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdatePrivateAccessChannelRequest
      * @return UpdatePrivateAccessChannelResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/UpdatePrivateAccessChannel.ts.html |here} to see how to use UpdatePrivateAccessChannel API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/UpdatePrivateAccessChannel.ts.html |here} to see how to use UpdatePrivateAccessChannel API.
      */
     updatePrivateAccessChannel(updatePrivateAccessChannelRequest: requests.UpdatePrivateAccessChannelRequest): Promise<responses.UpdatePrivateAccessChannelResponse>;
     /**
      * Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
      *
+     * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateVanityUrlRequest
      * @return UpdateVanityUrlResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/analytics/UpdateVanityUrl.ts.html |here} to see how to use UpdateVanityUrl API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/UpdateVanityUrl.ts.html |here} to see how to use UpdateVanityUrl API.
      */
     updateVanityUrl(updateVanityUrlRequest: requests.UpdateVanityUrlRequest): Promise<responses.UpdateVanityUrlResponse>;
 }