oci-analytics 2.137.0 → 2.137.1

package/lib/client.d.ts

@@ -98,7 +98,7 @@ export declare class AnalyticsClient {
     close(): void;
     /**
      * Change the compartment of an Analytics instance. The operation is long-running
-     * and creates a new WorkRequest.
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ChangeAnalyticsInstanceCompartmentRequest
@@ -108,8 +108,8 @@ export declare class AnalyticsClient {
      */
     changeAnalyticsInstanceCompartment(changeAnalyticsInstanceCompartmentRequest: requests.ChangeAnalyticsInstanceCompartmentRequest): Promise<responses.ChangeAnalyticsInstanceCompartmentResponse>;
     /**
-     * Change an Analytics instance network endpoint. The operation is long-running
-     * and creates a new WorkRequest.
+     * Change the network endpoint for an Analytics instance. The operation is long-running
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ChangeAnalyticsInstanceNetworkEndpointRequest
@@ -119,8 +119,8 @@ export declare class AnalyticsClient {
      */
     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.
+     * Create a new Analytics instance in the specified compartment. The operation is long-running
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreateAnalyticsInstanceRequest
@@ -130,8 +130,8 @@ export declare class AnalyticsClient {
      */
     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.
+     * Create an private access channel for the Analytics instance. The operation is long-running
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreatePrivateAccessChannelRequest
@@ -141,8 +141,17 @@ export declare class AnalyticsClient {
      */
     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.
+     * Create a new resource group for the instance
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param CreateResourceGroupRequest
+     * @return CreateResourceGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/CreateResourceGroup.ts.html |here} to see how to use CreateResourceGroup API.
+     */
+    createResourceGroup(createResourceGroupRequest: requests.CreateResourceGroupRequest): Promise<responses.CreateResourceGroupResponse>;
+    /**
+     * Allows you to specify a custom host name to be used to access the Analytics instance.  You must set up a DNS entry and certificate for this host in advance.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param CreateVanityUrlRequest
@@ -152,8 +161,8 @@ export declare class AnalyticsClient {
      */
     createVanityUrl(createVanityUrlRequest: requests.CreateVanityUrlRequest): Promise<responses.CreateVanityUrlResponse>;
     /**
-     * Terminates the specified Analytics instance. The operation is long-running
-     * and creates a new WorkRequest.
+     * Deletes the specified Analytics instance. The operation is long-running
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param DeleteAnalyticsInstanceRequest
@@ -163,7 +172,7 @@ export declare class AnalyticsClient {
      */
     deleteAnalyticsInstance(deleteAnalyticsInstanceRequest: requests.DeleteAnalyticsInstanceRequest): Promise<responses.DeleteAnalyticsInstanceResponse>;
     /**
-     * Delete an Analytics instance's Private access channel with the given unique identifier key.
+     * Delete a private access channel with a given unique identifier key, for an Analytics instance.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param DeletePrivateAccessChannelRequest
@@ -173,7 +182,17 @@ export declare class AnalyticsClient {
      */
     deletePrivateAccessChannel(deletePrivateAccessChannelRequest: requests.DeletePrivateAccessChannelRequest): Promise<responses.DeletePrivateAccessChannelResponse>;
     /**
-     * Allows deleting a previously created vanity url.
+     * Allows deleting a previously created resource group.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param DeleteResourceGroupRequest
+     * @return DeleteResourceGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/DeleteResourceGroup.ts.html |here} to see how to use DeleteResourceGroup API.
+     */
+    deleteResourceGroup(deleteResourceGroupRequest: requests.DeleteResourceGroupRequest): Promise<responses.DeleteResourceGroupResponse>;
+    /**
+     * Deletes a previously created vanity URL.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param DeleteVanityUrlRequest
@@ -183,7 +202,7 @@ export declare class AnalyticsClient {
      */
     deleteVanityUrl(deleteVanityUrlRequest: requests.DeleteVanityUrlRequest): Promise<responses.DeleteVanityUrlResponse>;
     /**
-     * Cancel a work request that has not started yet.
+     * Cancel a work request that hasn't started yet.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteWorkRequestRequest
@@ -193,7 +212,7 @@ export declare class AnalyticsClient {
      */
     deleteWorkRequest(deleteWorkRequestRequest: requests.DeleteWorkRequestRequest): Promise<responses.DeleteWorkRequestResponse>;
     /**
-     * Info for a specific Analytics instance.
+     * Information about a specific Analytics instance.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetAnalyticsInstanceRequest
@@ -203,7 +222,7 @@ export declare class AnalyticsClient {
      */
     getAnalyticsInstance(getAnalyticsInstanceRequest: requests.GetAnalyticsInstanceRequest): Promise<responses.GetAnalyticsInstanceResponse>;
     /**
-     * Retrieve private access channel in the specified Analytics Instance.
+     * Retrieve private access channel for the specified Analytics Instance.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetPrivateAccessChannelRequest
@@ -212,6 +231,16 @@ export declare class AnalyticsClient {
      * @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<responses.GetPrivateAccessChannelResponse>;
+    /**
+     * Get details of a resource group for an instance
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param GetResourceGroupRequest
+     * @return GetResourceGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/GetResourceGroup.ts.html |here} to see how to use GetResourceGroup API.
+     */
+    getResourceGroup(getResourceGroupRequest: requests.GetResourceGroupRequest): Promise<responses.GetResourceGroupResponse>;
     /**
      * Get the details of a work request.
      *
@@ -264,6 +293,48 @@ export declare class AnalyticsClient {
      * @param request a request which can be sent to the service operation
      */
     listAnalyticsInstancesResponseIterator(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator<responses.ListAnalyticsInstancesResponse>;
+    /**
+     * List resource groups associated with an instance.
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param ListResourceGroupsRequest
+     * @return ListResourceGroupsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/ListResourceGroups.ts.html |here} to see how to use ListResourceGroups API.
+     */
+    listResourceGroups(listResourceGroupsRequest: requests.ListResourceGroupsRequest): Promise<responses.ListResourceGroupsResponse>;
+    /**
+     * NOTE: This function is deprecated in favor of listResourceGroupsRecordIterator function.
+     * Creates a new async iterator which will iterate over the models.InstanceResourceGroupSummary objects
+     * contained in responses from the listResourceGroups operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllResourceGroups(request: requests.ListResourceGroupsRequest): AsyncIterableIterator<model.InstanceResourceGroupSummary>;
+    /**
+     * NOTE: This function is deprecated in favor of listResourceGroupsResponseIterator function.
+     * Creates a new async iterator which will iterate over the responses received from the listResourceGroups operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listAllResourceGroupsResponses(request: requests.ListResourceGroupsRequest): AsyncIterableIterator<responses.ListResourceGroupsResponse>;
+    /**
+     * Creates a new async iterator which will iterate over the models.InstanceResourceGroupSummary objects
+     * contained in responses from the listResourceGroups operation. This iterator will fetch more data from the
+     * server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listResourceGroupsRecordIterator(request: requests.ListResourceGroupsRequest): AsyncIterableIterator<model.InstanceResourceGroupSummary>;
+    /**
+     * Creates a new async iterator which will iterate over the responses received from the listResourceGroups operation. This iterator
+     * will fetch more data from the server as needed.
+     *
+     * @param request a request which can be sent to the service operation
+     */
+    listResourceGroupsResponseIterator(request: requests.ListResourceGroupsRequest): AsyncIterableIterator<responses.ListResourceGroupsResponse>;
     /**
      * Get the errors of a work request.
      *
@@ -392,7 +463,7 @@ export declare class AnalyticsClient {
     listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
     /**
      * Scale an Analytics instance up or down. The operation is long-running
-     * and creates a new WorkRequest.
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ScaleAnalyticsInstanceRequest
@@ -412,7 +483,7 @@ export declare class AnalyticsClient {
      */
     setFeatureBundle(setFeatureBundleRequest: requests.SetFeatureBundleRequest): Promise<responses.SetFeatureBundleResponse>;
     /**
-     * Encrypts the customer data of this Analytics instance using either a customer OCI Vault Key or Oracle managed default key.
+     * Encrypts the customer data of this Analytics instance using either a customer OCI vault key or default Oracle-managed key.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param SetKmsKeyRequest
@@ -423,7 +494,7 @@ export declare class AnalyticsClient {
     setKmsKey(setKmsKeyRequest: requests.SetKmsKeyRequest): Promise<responses.SetKmsKeyResponse>;
     /**
      * Starts the specified Analytics instance. The operation is long-running
-     * and creates a new WorkRequest.
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param StartAnalyticsInstanceRequest
@@ -434,7 +505,7 @@ export declare class AnalyticsClient {
     startAnalyticsInstance(startAnalyticsInstanceRequest: requests.StartAnalyticsInstanceRequest): Promise<responses.StartAnalyticsInstanceResponse>;
     /**
      * Stop the specified Analytics instance. The operation is long-running
-     * and creates a new WorkRequest.
+     * and creates a new work request.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param StopAnalyticsInstanceRequest
@@ -455,7 +526,7 @@ export declare class AnalyticsClient {
      */
     updateAnalyticsInstance(updateAnalyticsInstanceRequest: requests.UpdateAnalyticsInstanceRequest): Promise<responses.UpdateAnalyticsInstanceResponse>;
     /**
-     * Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
+     * 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
@@ -465,7 +536,17 @@ export declare class AnalyticsClient {
      */
     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.
+     * Update any fields in a resource group
+     *
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
+     * @param UpdateResourceGroupRequest
+     * @return UpdateResourceGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/analytics/UpdateResourceGroup.ts.html |here} to see how to use UpdateResourceGroup API.
+     */
+    updateResourceGroup(updateResourceGroupRequest: requests.UpdateResourceGroupRequest): Promise<responses.UpdateResourceGroupResponse>;
+    /**
+     * Uploads a new certificate for a vanity URL. Required before the current certificate expires.
      *
      * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param UpdateVanityUrlRequest