oci-databasetools 2.28.0 → 2.31.0

package/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * Database Tools
- * Database Tools APIs to manage Connections and Private Endpoints.
+ * Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.
  * OpenAPI spec version: 20201005
  *
  *

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 /**
  * Database Tools
- * Database Tools APIs to manage Connections and Private Endpoints.
+ * Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.
  * OpenAPI spec version: 20201005
  *
  *

package/lib/client.d.ts

@@ -1,6 +1,6 @@
 /**
  * Database Tools
- * Database Tools APIs to manage Connections and Private Endpoints.
+ * Use the Database Tools API to manage connections, private endpoints, and work requests in the Database Tools service.
  * OpenAPI spec version: 20201005
  *
  *
@@ -70,7 +70,7 @@ export declare class DatabaseToolsClient {
      */
     getWaiters(): DatabaseToolsWaiter;
     /**
-     * Moves a DatabaseToolsConnection into a different compartment within the same tenancy.
+     * Moves the specified Database Tools connection to a different compartment in the same tenancy.
      * For information about moving resources between compartments, see
      * [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
      *
@@ -78,11 +78,11 @@ export declare class DatabaseToolsClient {
      * @param ChangeDatabaseToolsConnectionCompartmentRequest
      * @return ChangeDatabaseToolsConnectionCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/ChangeDatabaseToolsConnectionCompartment.ts.html |here} to see how to use ChangeDatabaseToolsConnectionCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/ChangeDatabaseToolsConnectionCompartment.ts.html |here} to see how to use ChangeDatabaseToolsConnectionCompartment API.
      */
     changeDatabaseToolsConnectionCompartment(changeDatabaseToolsConnectionCompartmentRequest: requests.ChangeDatabaseToolsConnectionCompartmentRequest): Promise<responses.ChangeDatabaseToolsConnectionCompartmentResponse>;
     /**
-     * Moves a DatabaseToolsPrivateEndpoint into a different compartment within the same tenancy.
+     * Moves a Database Tools private endpoint into a different compartment in the same tenancy.
      * For information about moving resources between compartments, see
      * [Moving Resources to a Different Compartment](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
      *
@@ -90,169 +90,169 @@ export declare class DatabaseToolsClient {
      * @param ChangeDatabaseToolsPrivateEndpointCompartmentRequest
      * @return ChangeDatabaseToolsPrivateEndpointCompartmentResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/ChangeDatabaseToolsPrivateEndpointCompartment.ts.html |here} to see how to use ChangeDatabaseToolsPrivateEndpointCompartment API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/ChangeDatabaseToolsPrivateEndpointCompartment.ts.html |here} to see how to use ChangeDatabaseToolsPrivateEndpointCompartment API.
      */
     changeDatabaseToolsPrivateEndpointCompartment(changeDatabaseToolsPrivateEndpointCompartmentRequest: requests.ChangeDatabaseToolsPrivateEndpointCompartmentRequest): Promise<responses.ChangeDatabaseToolsPrivateEndpointCompartmentResponse>;
     /**
-     * Creates a new DatabaseToolsConnection.
+     * Creates a new Database Tools connection.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateDatabaseToolsConnectionRequest
      * @return CreateDatabaseToolsConnectionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/CreateDatabaseToolsConnection.ts.html |here} to see how to use CreateDatabaseToolsConnection API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/CreateDatabaseToolsConnection.ts.html |here} to see how to use CreateDatabaseToolsConnection API.
      */
     createDatabaseToolsConnection(createDatabaseToolsConnectionRequest: requests.CreateDatabaseToolsConnectionRequest): Promise<responses.CreateDatabaseToolsConnectionResponse>;
     /**
-     * Creates a new DatabaseToolsPrivateEndpoint.
+     * Creates a new Database Tools private endpoint.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param CreateDatabaseToolsPrivateEndpointRequest
      * @return CreateDatabaseToolsPrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/CreateDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use CreateDatabaseToolsPrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/CreateDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use CreateDatabaseToolsPrivateEndpoint API.
      */
     createDatabaseToolsPrivateEndpoint(createDatabaseToolsPrivateEndpointRequest: requests.CreateDatabaseToolsPrivateEndpointRequest): Promise<responses.CreateDatabaseToolsPrivateEndpointResponse>;
     /**
-     * Deletes a DatabaseToolsConnection resource by identifier
+     * Deletes the specified Database Tools connection resource.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteDatabaseToolsConnectionRequest
      * @return DeleteDatabaseToolsConnectionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/DeleteDatabaseToolsConnection.ts.html |here} to see how to use DeleteDatabaseToolsConnection API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/DeleteDatabaseToolsConnection.ts.html |here} to see how to use DeleteDatabaseToolsConnection API.
      */
     deleteDatabaseToolsConnection(deleteDatabaseToolsConnectionRequest: requests.DeleteDatabaseToolsConnectionRequest): Promise<responses.DeleteDatabaseToolsConnectionResponse>;
     /**
-     * Deletes a DatabaseToolsPrivateEndpoint resource by identifier
+     * Deletes the specified Database Tools private endpoint.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param DeleteDatabaseToolsPrivateEndpointRequest
      * @return DeleteDatabaseToolsPrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/DeleteDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use DeleteDatabaseToolsPrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/DeleteDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use DeleteDatabaseToolsPrivateEndpoint API.
      */
     deleteDatabaseToolsPrivateEndpoint(deleteDatabaseToolsPrivateEndpointRequest: requests.DeleteDatabaseToolsPrivateEndpointRequest): Promise<responses.DeleteDatabaseToolsPrivateEndpointResponse>;
     /**
-     * Gets a DatabaseToolsConnection by identifier
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * Gets details of the specified Database Tools connection.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetDatabaseToolsConnectionRequest
      * @return GetDatabaseToolsConnectionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/GetDatabaseToolsConnection.ts.html |here} to see how to use GetDatabaseToolsConnection API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/GetDatabaseToolsConnection.ts.html |here} to see how to use GetDatabaseToolsConnection API.
      */
     getDatabaseToolsConnection(getDatabaseToolsConnectionRequest: requests.GetDatabaseToolsConnectionRequest): Promise<responses.GetDatabaseToolsConnectionResponse>;
     /**
-     * Gets a DatabaseToolsEndpointService by identifier
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * Gets details for the specified Database Tools endpoint service.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetDatabaseToolsEndpointServiceRequest
      * @return GetDatabaseToolsEndpointServiceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/GetDatabaseToolsEndpointService.ts.html |here} to see how to use GetDatabaseToolsEndpointService API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/GetDatabaseToolsEndpointService.ts.html |here} to see how to use GetDatabaseToolsEndpointService API.
      */
     getDatabaseToolsEndpointService(getDatabaseToolsEndpointServiceRequest: requests.GetDatabaseToolsEndpointServiceRequest): Promise<responses.GetDatabaseToolsEndpointServiceResponse>;
     /**
-     * Gets a DatabaseToolsPrivateEndpoint by identifier
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * Gets details of a specified Database Tools private endpoint.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param GetDatabaseToolsPrivateEndpointRequest
      * @return GetDatabaseToolsPrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/GetDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use GetDatabaseToolsPrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/GetDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use GetDatabaseToolsPrivateEndpoint API.
      */
     getDatabaseToolsPrivateEndpoint(getDatabaseToolsPrivateEndpointRequest: requests.GetDatabaseToolsPrivateEndpointRequest): Promise<responses.GetDatabaseToolsPrivateEndpointResponse>;
     /**
-     * Gets the status of the work request with the given ID.
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * Gets the status of the specified 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/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.31.0/databasetools/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
      */
     getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
     /**
-     * Returns a list of DatabaseToolsConnections.
+     * Returns a list of Database Tools connections.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListDatabaseToolsConnectionsRequest
      * @return ListDatabaseToolsConnectionsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/ListDatabaseToolsConnections.ts.html |here} to see how to use ListDatabaseToolsConnections API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/ListDatabaseToolsConnections.ts.html |here} to see how to use ListDatabaseToolsConnections API.
      */
     listDatabaseToolsConnections(listDatabaseToolsConnectionsRequest: requests.ListDatabaseToolsConnectionsRequest): Promise<responses.ListDatabaseToolsConnectionsResponse>;
     /**
-     * Returns a list of DatabaseToolsEndpointServices.
+     * Returns a list of Database Tools endpoint services.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListDatabaseToolsEndpointServicesRequest
      * @return ListDatabaseToolsEndpointServicesResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/ListDatabaseToolsEndpointServices.ts.html |here} to see how to use ListDatabaseToolsEndpointServices API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/ListDatabaseToolsEndpointServices.ts.html |here} to see how to use ListDatabaseToolsEndpointServices API.
      */
     listDatabaseToolsEndpointServices(listDatabaseToolsEndpointServicesRequest: requests.ListDatabaseToolsEndpointServicesRequest): Promise<responses.ListDatabaseToolsEndpointServicesResponse>;
     /**
-     * Returns a list of DatabaseToolsPrivateEndpoints.
+     * Returns a list of Database Tools private endpoints.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.
      * @param ListDatabaseToolsPrivateEndpointsRequest
      * @return ListDatabaseToolsPrivateEndpointsResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/ListDatabaseToolsPrivateEndpoints.ts.html |here} to see how to use ListDatabaseToolsPrivateEndpoints API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/ListDatabaseToolsPrivateEndpoints.ts.html |here} to see how to use ListDatabaseToolsPrivateEndpoints API.
      */
     listDatabaseToolsPrivateEndpoints(listDatabaseToolsPrivateEndpointsRequest: requests.ListDatabaseToolsPrivateEndpointsRequest): Promise<responses.ListDatabaseToolsPrivateEndpointsResponse>;
     /**
-     * Return a (paginated) list of errors for a given work request.
+     * Returns a paginated list of errors for the specified work request.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/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.31.0/databasetools/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
      */
     listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
     /**
-     * Return a (paginated) list of logs for a given work request.
+     * Returns a paginated list of logs for the specified work request.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/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.31.0/databasetools/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
      */
     listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
     /**
      * Lists the work requests in a compartment.
      *
-     * This operation does not retry by default if the user has not defined a retry configuration.
+     * 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.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/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.31.0/databasetools/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
      */
     listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
     /**
-     * Updates the DatabaseToolsConnection
+     * Updates the specified Database Tools connection.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateDatabaseToolsConnectionRequest
      * @return UpdateDatabaseToolsConnectionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/UpdateDatabaseToolsConnection.ts.html |here} to see how to use UpdateDatabaseToolsConnection API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/UpdateDatabaseToolsConnection.ts.html |here} to see how to use UpdateDatabaseToolsConnection API.
      */
     updateDatabaseToolsConnection(updateDatabaseToolsConnectionRequest: requests.UpdateDatabaseToolsConnectionRequest): Promise<responses.UpdateDatabaseToolsConnectionResponse>;
     /**
-     * Updates the DatabaseToolsPrivateEndpoint
+     * Updates the specified Database Tools private endpoint.
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param UpdateDatabaseToolsPrivateEndpointRequest
      * @return UpdateDatabaseToolsPrivateEndpointResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/UpdateDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use UpdateDatabaseToolsPrivateEndpoint API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/UpdateDatabaseToolsPrivateEndpoint.ts.html |here} to see how to use UpdateDatabaseToolsPrivateEndpoint API.
      */
     updateDatabaseToolsPrivateEndpoint(updateDatabaseToolsPrivateEndpointRequest: requests.UpdateDatabaseToolsPrivateEndpointRequest): Promise<responses.UpdateDatabaseToolsPrivateEndpointResponse>;
     /**
-     * Validate the DatabaseToolsConnection information details by establishing a connection to the database.
+     * Validates the Database Tools connection details by establishing a connection to the database.
      *
      * This operation does not retry by default if the user has not defined a retry configuration.
      * @param ValidateDatabaseToolsConnectionRequest
      * @return ValidateDatabaseToolsConnectionResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.28.0/databasetools/ValidateDatabaseToolsConnection.ts.html |here} to see how to use ValidateDatabaseToolsConnection API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.31.0/databasetools/ValidateDatabaseToolsConnection.ts.html |here} to see how to use ValidateDatabaseToolsConnection API.
      */
     validateDatabaseToolsConnection(validateDatabaseToolsConnectionRequest: requests.ValidateDatabaseToolsConnectionRequest): Promise<responses.ValidateDatabaseToolsConnectionResponse>;
 }