oci-databasetools 2.6.1

package/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Database Tools
+ * Database Tools APIs to manage Connections and Private Endpoints.
+ * OpenAPI spec version: 20201005
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2021, 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 * as requests from "./lib/request";
+import * as models from "./lib/model";
+import * as responses from "./lib/response";
+import * as client from "./lib/client";
+import * as databasetools_waiter from "./lib/databasetools-waiter";
+export { models };
+export { requests };
+export { responses };
+export import DatabaseToolsClient = client.DatabaseToolsClient;
+export import DatabaseToolsWaiter = databasetools_waiter.DatabaseToolsWaiter;

package/index.js

@@ -0,0 +1,45 @@
+"use strict";
+/**
+ * Database Tools
+ * Database Tools APIs to manage Connections and Private Endpoints.
+ * OpenAPI spec version: 20201005
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2021, 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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DatabaseToolsWaiter = exports.DatabaseToolsClient = exports.responses = exports.requests = exports.models = void 0;
+const requests = __importStar(require("./lib/request"));
+exports.requests = requests;
+const models = __importStar(require("./lib/model"));
+exports.models = models;
+const responses = __importStar(require("./lib/response"));
+exports.responses = responses;
+const client = __importStar(require("./lib/client"));
+const databasetools_waiter = __importStar(require("./lib/databasetools-waiter"));
+exports.DatabaseToolsClient = client.DatabaseToolsClient;
+exports.DatabaseToolsWaiter = databasetools_waiter.DatabaseToolsWaiter;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/databasetools/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAOjC,4BAAQ;AANjB,oDAAsC;AAK7B,wBAAM;AAJf,0DAA4C;AAMnC,8BAAS;AALlB,qDAAuC;AACvC,iFAAmE;AAKrD,QAAA,mBAAmB,GAAG,MAAM,CAAC,mBAAmB,CAAC;AACjD,QAAA,mBAAmB,GAAG,oBAAoB,CAAC,mBAAmB,CAAC"}

package/lib/client.d.ts

@@ -0,0 +1,255 @@
+/**
+ * Database Tools
+ * Database Tools APIs to manage Connections and Private Endpoints.
+ * OpenAPI spec version: 20201005
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2021, 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 responses from "./response";
+import { DatabaseToolsWaiter } from "./databasetools-waiter";
+export declare enum DatabaseToolsApiKeys {
+}
+/**
+ * This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
+ */
+export declare class DatabaseToolsClient {
+    protected static serviceEndpointTemplate: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": DatabaseToolsWaiter;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: null;
+    protected _httpClient: common.HttpClient;
+    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;
+    /**
+     * 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 DatabaseToolsWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): DatabaseToolsWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): DatabaseToolsWaiter;
+    /**
+     * Moves a DatabaseToolsConnection into a different compartment within 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).
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @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.6.1/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.
+     * 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).
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @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.6.1/databasetools/ChangeDatabaseToolsPrivateEndpointCompartment.ts.html |here} to see how to use ChangeDatabaseToolsPrivateEndpointCompartment API.
+     */
+    changeDatabaseToolsPrivateEndpointCompartment(changeDatabaseToolsPrivateEndpointCompartmentRequest: requests.ChangeDatabaseToolsPrivateEndpointCompartmentRequest): Promise<responses.ChangeDatabaseToolsPrivateEndpointCompartmentResponse>;
+    /**
+     * Creates a new DatabaseToolsConnection.
+     *
+     * 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.6.1/databasetools/CreateDatabaseToolsConnection.ts.html |here} to see how to use CreateDatabaseToolsConnection API.
+     */
+    createDatabaseToolsConnection(createDatabaseToolsConnectionRequest: requests.CreateDatabaseToolsConnectionRequest): Promise<responses.CreateDatabaseToolsConnectionResponse>;
+    /**
+     * Creates a new DatabaseToolsPrivateEndpoint.
+     *
+     * 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.6.1/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
+     * 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.6.1/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
+     * 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.6.1/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.
+     * @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.6.1/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.
+     * @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.6.1/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.
+     * @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.6.1/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.
+     * @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.6.1/databasetools/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
+     */
+    getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
+    /**
+     * Returns a list of DatabaseToolsConnections.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @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.6.1/databasetools/ListDatabaseToolsConnections.ts.html |here} to see how to use ListDatabaseToolsConnections API.
+     */
+    listDatabaseToolsConnections(listDatabaseToolsConnectionsRequest: requests.ListDatabaseToolsConnectionsRequest): Promise<responses.ListDatabaseToolsConnectionsResponse>;
+    /**
+     * Returns a list of DatabaseToolsEndpointServices.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @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.6.1/databasetools/ListDatabaseToolsEndpointServices.ts.html |here} to see how to use ListDatabaseToolsEndpointServices API.
+     */
+    listDatabaseToolsEndpointServices(listDatabaseToolsEndpointServicesRequest: requests.ListDatabaseToolsEndpointServicesRequest): Promise<responses.ListDatabaseToolsEndpointServicesResponse>;
+    /**
+     * Returns a list of DatabaseToolsPrivateEndpoints.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @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.6.1/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.
+     *
+     * 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.6.1/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.
+     *
+     * 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.6.1/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.
+     * @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.6.1/databasetools/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
+     */
+    listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
+    /**
+     * Updates the DatabaseToolsConnection
+     * 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.6.1/databasetools/UpdateDatabaseToolsConnection.ts.html |here} to see how to use UpdateDatabaseToolsConnection API.
+     */
+    updateDatabaseToolsConnection(updateDatabaseToolsConnectionRequest: requests.UpdateDatabaseToolsConnectionRequest): Promise<responses.UpdateDatabaseToolsConnectionResponse>;
+    /**
+     * Updates the DatabaseToolsPrivateEndpoint
+     * 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.6.1/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.
+     *
+     * 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.6.1/databasetools/ValidateDatabaseToolsConnection.ts.html |here} to see how to use ValidateDatabaseToolsConnection API.
+     */
+    validateDatabaseToolsConnection(validateDatabaseToolsConnectionRequest: requests.ValidateDatabaseToolsConnectionRequest): Promise<responses.ValidateDatabaseToolsConnectionResponse>;
+}