oci-dashboardservice 2.12.1

package/lib/client.js

@@ -0,0 +1,894 @@
+"use strict";
+/**
+ * Dashboards API
+ * Use the Oracle Cloud Infrastructure Dashboards service API to manage dashboards in the Console.
+Dashboards provide an organized and customizable view of resources and their metrics in the Console.
+For more information, see [Dashboards](/Content/Dashboards/home.htm).
+
+**Important:** Resources for the Dashboards service are created in the tenacy's home region.
+Although it is possible to create dashboard and dashboard group resources in regions other than the home region,
+you won't be able to view those resources in the Console.
+Therefore, creating resources outside of the home region is not recommended.
+
+ * OpenAPI spec version: 20210731
+ *
+ *
+ * NOTE: This class is auto generated by OracleSDKGenerator.
+ * Do not edit the class manually.
+ *
+ * Copyright (c) 2020, 2022, 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;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardGroupClient = exports.DashboardGroupApiKeys = exports.DashboardClient = exports.DashboardApiKeys = void 0;
+const common = require("oci-common");
+const model = __importStar(require("./model"));
+const dashboard_waiter_1 = require("./dashboard-waiter");
+const dashboardgroup_waiter_1 = require("./dashboardgroup-waiter");
+const oci_common_1 = require("oci-common");
+// ===============================================
+// This file is autogenerated - Please do not edit
+// ===============================================
+var DashboardApiKeys;
+(function (DashboardApiKeys) {
+})(DashboardApiKeys = exports.DashboardApiKeys || (exports.DashboardApiKeys = {}));
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+class DashboardClient {
+    constructor(params, clientConfiguration) {
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        const requestSigner = params.authenticationDetailsProvider
+            ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
+            : null;
+        if (clientConfiguration) {
+            this._clientConfiguration = clientConfiguration;
+            this._circuitBreaker = clientConfiguration.circuitBreaker
+                ? clientConfiguration.circuitBreaker.circuit
+                : null;
+        }
+        // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
+        const specCircuitBreakerEnabled = true;
+        if (!this._circuitBreaker &&
+            common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) &&
+            (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
+            this._circuitBreaker = new common.CircuitBreaker().circuit;
+        }
+        this._httpClient =
+            params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
+        if (params.authenticationDetailsProvider &&
+            common.isRegionProvider(params.authenticationDetailsProvider)) {
+            const provider = params.authenticationDetailsProvider;
+            if (provider.getRegion()) {
+                this.region = provider.getRegion();
+            }
+        }
+    }
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint() {
+        return this._endpoint;
+    }
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint) {
+        this._endpoint = endpoint;
+        this._endpoint = this._endpoint + "/20210731";
+        if (this.logger)
+            this.logger.info(`DashboardClient endpoint set to ${this._endpoint}`);
+    }
+    get logger() {
+        return common.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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegion(DashboardClient.serviceEndpointTemplate, 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(DashboardClient.serviceEndpointTemplate, regionId);
+    }
+    /**
+     * Creates a new DashboardWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config) {
+        this._waiters = new dashboard_waiter_1.DashboardWaiter(this, config);
+        return this._waiters;
+    }
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters() {
+        if (this._waiters) {
+            return this._waiters;
+        }
+        throw Error("Waiters do not exist. Please create waiters.");
+    }
+    /**
+     * Creates a new dashboard in the dashboard group's compartment using the details provided in request body.
+     * <p>
+     **Caution:** Resources for the Dashboard service are created in the tenacy's home region.
+     * Although it is possible to create dashboard resource in regions other than the home region,
+     * you won't be able to view those resources in the Console.
+     * Therefore, creating resources outside of the home region is not recommended.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateDashboardRequest
+     * @return CreateDashboardResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/CreateDashboard.ts.html |here} to see how to use CreateDashboard API.
+     */
+    createDashboard(createDashboardRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardClient#createDashboard.");
+            const pathParams = {};
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-retry-token": createDashboardRequest.opcRetryToken,
+                "opc-request-id": createDashboardRequest.opcRequestId,
+                "opc-cross-region": createDashboardRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, createDashboardRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboards",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(createDashboardRequest.createDashboardDetails, "CreateDashboardDetails", model.CreateDashboardDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboard",
+                    bodyModel: model.Dashboard,
+                    type: "model.Dashboard",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Deletes the specified dashboard. Uses the dashboard's OCID to determine which dashboard to delete.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteDashboardRequest
+     * @return DeleteDashboardResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/DeleteDashboard.ts.html |here} to see how to use DeleteDashboard API.
+     */
+    deleteDashboard(deleteDashboardRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardClient#deleteDashboard.");
+            const pathParams = {
+                "{dashboardId}": deleteDashboardRequest.dashboardId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": deleteDashboardRequest.ifMatch,
+                "opc-request-id": deleteDashboardRequest.opcRequestId,
+                "opc-cross-region": deleteDashboardRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, deleteDashboardRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboards/{dashboardId}",
+                method: "DELETE",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Gets the specified dashboard's information. Uses the dashboard's OCID to determine which dashboard to retrieve.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetDashboardRequest
+     * @return GetDashboardResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/GetDashboard.ts.html |here} to see how to use GetDashboard API.
+     */
+    getDashboard(getDashboardRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardClient#getDashboard.");
+            const pathParams = {
+                "{dashboardId}": getDashboardRequest.dashboardId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": getDashboardRequest.opcRequestId,
+                "opc-cross-region": getDashboardRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getDashboardRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboards/{dashboardId}",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboard",
+                    bodyModel: model.Dashboard,
+                    type: "model.Dashboard",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Returns a list of dashboards with a specific dashboard group ID.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListDashboardsRequest
+     * @return ListDashboardsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/ListDashboards.ts.html |here} to see how to use ListDashboards API.
+     */
+    listDashboards(listDashboardsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardClient#listDashboards.");
+            const pathParams = {};
+            const queryParams = {
+                "dashboardGroupId": listDashboardsRequest.dashboardGroupId,
+                "lifecycleState": listDashboardsRequest.lifecycleState,
+                "displayName": listDashboardsRequest.displayName,
+                "id": listDashboardsRequest.id,
+                "limit": listDashboardsRequest.limit,
+                "page": listDashboardsRequest.page,
+                "sortOrder": listDashboardsRequest.sortOrder,
+                "sortBy": listDashboardsRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listDashboardsRequest.opcRequestId,
+                "opc-cross-region": listDashboardsRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listDashboardsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboards",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboardCollection",
+                    bodyModel: model.DashboardCollection,
+                    type: "model.DashboardCollection",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Updates the specified dashboard. Uses the dashboard's OCID to determine which dashboard to update.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateDashboardRequest
+     * @return UpdateDashboardResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/UpdateDashboard.ts.html |here} to see how to use UpdateDashboard API.
+     */
+    updateDashboard(updateDashboardRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardClient#updateDashboard.");
+            const pathParams = {
+                "{dashboardId}": updateDashboardRequest.dashboardId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": updateDashboardRequest.ifMatch,
+                "opc-request-id": updateDashboardRequest.opcRequestId,
+                "opc-cross-region": updateDashboardRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateDashboardRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboards/{dashboardId}",
+                method: "PUT",
+                bodyContent: common.ObjectSerializer.serialize(updateDashboardRequest.updateDashboardDetails, "UpdateDashboardDetails", model.UpdateDashboardDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboard",
+                    bodyModel: model.Dashboard,
+                    type: "model.Dashboard",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+}
+exports.DashboardClient = DashboardClient;
+DashboardClient.serviceEndpointTemplate = "https://dashboard.{region}.oci.{secondLevelDomain}";
+var DashboardGroupApiKeys;
+(function (DashboardGroupApiKeys) {
+})(DashboardGroupApiKeys = exports.DashboardGroupApiKeys || (exports.DashboardGroupApiKeys = {}));
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+class DashboardGroupClient {
+    constructor(params, clientConfiguration) {
+        this["_endpoint"] = "";
+        this["_defaultHeaders"] = {};
+        this._circuitBreaker = null;
+        const requestSigner = params.authenticationDetailsProvider
+            ? new common.DefaultRequestSigner(params.authenticationDetailsProvider)
+            : null;
+        if (clientConfiguration) {
+            this._clientConfiguration = clientConfiguration;
+            this._circuitBreaker = clientConfiguration.circuitBreaker
+                ? clientConfiguration.circuitBreaker.circuit
+                : null;
+        }
+        // if circuit breaker is not created, check if circuit breaker system is enabled to use default circuit breaker
+        const specCircuitBreakerEnabled = true;
+        if (!this._circuitBreaker &&
+            common.utils.isCircuitBreakerSystemEnabled(clientConfiguration) &&
+            (specCircuitBreakerEnabled || common.CircuitBreaker.DefaultCircuitBreakerOverriden)) {
+            this._circuitBreaker = new common.CircuitBreaker().circuit;
+        }
+        this._httpClient =
+            params.httpClient || new common.FetchHttpClient(requestSigner, this._circuitBreaker);
+        if (params.authenticationDetailsProvider &&
+            common.isRegionProvider(params.authenticationDetailsProvider)) {
+            const provider = params.authenticationDetailsProvider;
+            if (provider.getRegion()) {
+                this.region = provider.getRegion();
+            }
+        }
+    }
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint() {
+        return this._endpoint;
+    }
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint) {
+        this._endpoint = endpoint;
+        this._endpoint = this._endpoint + "/20210731";
+        if (this.logger)
+            this.logger.info(`DashboardGroupClient endpoint set to ${this._endpoint}`);
+    }
+    get logger() {
+        return common.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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegion(DashboardGroupClient.serviceEndpointTemplate, 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) {
+        this.endpoint = common.EndpointBuilder.createEndpointFromRegionId(DashboardGroupClient.serviceEndpointTemplate, regionId);
+    }
+    /**
+     * Creates a new DashboardGroupWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config) {
+        this._waiters = new dashboardgroup_waiter_1.DashboardGroupWaiter(this, config);
+        return this._waiters;
+    }
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters() {
+        if (this._waiters) {
+            return this._waiters;
+        }
+        throw Error("Waiters do not exist. Please create waiters.");
+    }
+    /**
+     * Creates a new dashboard group using the details provided in request body.
+     * <p>
+     **Caution:** Resources for the Dashboard service are created in the tenacy's home region.
+     * Although it is possible to create dashboard group resource in regions other than the home region,
+     * you won't be able to view those resources in the Console.
+     * Therefore, creating resources outside of the home region is not recommended.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param CreateDashboardGroupRequest
+     * @return CreateDashboardGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/CreateDashboardGroup.ts.html |here} to see how to use CreateDashboardGroup API.
+     */
+    createDashboardGroup(createDashboardGroupRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardGroupClient#createDashboardGroup.");
+            const pathParams = {};
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-retry-token": createDashboardGroupRequest.opcRetryToken,
+                "opc-request-id": createDashboardGroupRequest.opcRequestId,
+                "opc-cross-region": createDashboardGroupRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, createDashboardGroupRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboardGroups",
+                method: "POST",
+                bodyContent: common.ObjectSerializer.serialize(createDashboardGroupRequest.createDashboardGroupDetails, "CreateDashboardGroupDetails", model.CreateDashboardGroupDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboardGroup",
+                    bodyModel: model.DashboardGroup,
+                    type: "model.DashboardGroup",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Deletes the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to delete.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param DeleteDashboardGroupRequest
+     * @return DeleteDashboardGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/DeleteDashboardGroup.ts.html |here} to see how to use DeleteDashboardGroup API.
+     */
+    deleteDashboardGroup(deleteDashboardGroupRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardGroupClient#deleteDashboardGroup.");
+            const pathParams = {
+                "{dashboardGroupId}": deleteDashboardGroupRequest.dashboardGroupId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": deleteDashboardGroupRequest.ifMatch,
+                "opc-request-id": deleteDashboardGroupRequest.opcRequestId,
+                "opc-cross-region": deleteDashboardGroupRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, deleteDashboardGroupRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboardGroups/{dashboardGroupId}",
+                method: "DELETE",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Gets the specified dashboard group's information. Uses the dashboard group's OCID to determine which dashboard to retrieve.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetDashboardGroupRequest
+     * @return GetDashboardGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/GetDashboardGroup.ts.html |here} to see how to use GetDashboardGroup API.
+     */
+    getDashboardGroup(getDashboardGroupRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardGroupClient#getDashboardGroup.");
+            const pathParams = {
+                "{dashboardGroupId}": getDashboardGroupRequest.dashboardGroupId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": getDashboardGroupRequest.opcRequestId,
+                "opc-cross-region": getDashboardGroupRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, getDashboardGroupRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboardGroups/{dashboardGroupId}",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboardGroup",
+                    bodyModel: model.DashboardGroup,
+                    type: "model.DashboardGroup",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Returns a list of dashboard groups with a specific compartment ID.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param ListDashboardGroupsRequest
+     * @return ListDashboardGroupsResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/ListDashboardGroups.ts.html |here} to see how to use ListDashboardGroups API.
+     */
+    listDashboardGroups(listDashboardGroupsRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardGroupClient#listDashboardGroups.");
+            const pathParams = {};
+            const queryParams = {
+                "compartmentId": listDashboardGroupsRequest.compartmentId,
+                "lifecycleState": listDashboardGroupsRequest.lifecycleState,
+                "displayName": listDashboardGroupsRequest.displayName,
+                "id": listDashboardGroupsRequest.id,
+                "limit": listDashboardGroupsRequest.limit,
+                "page": listDashboardGroupsRequest.page,
+                "sortOrder": listDashboardGroupsRequest.sortOrder,
+                "sortBy": listDashboardGroupsRequest.sortBy
+            };
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "opc-request-id": listDashboardGroupsRequest.opcRequestId,
+                "opc-cross-region": listDashboardGroupsRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, listDashboardGroupsRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboardGroups",
+                method: "GET",
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboardGroupCollection",
+                    bodyModel: model.DashboardGroupCollection,
+                    type: "model.DashboardGroupCollection",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-next-page"),
+                            key: "opcNextPage",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+    /**
+     * Updates the specified dashboard group. Uses the dashboard group's OCID to determine which dashboard group to update.
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param UpdateDashboardGroupRequest
+     * @return UpdateDashboardGroupResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.12.1/dashboardservice/UpdateDashboardGroup.ts.html |here} to see how to use UpdateDashboardGroup API.
+     */
+    updateDashboardGroup(updateDashboardGroupRequest) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.logger)
+                this.logger.debug("Calling operation DashboardGroupClient#updateDashboardGroup.");
+            const pathParams = {
+                "{dashboardGroupId}": updateDashboardGroupRequest.dashboardGroupId
+            };
+            const queryParams = {};
+            let headerParams = {
+                "Content-Type": common.Constants.APPLICATION_JSON,
+                "if-match": updateDashboardGroupRequest.ifMatch,
+                "opc-request-id": updateDashboardGroupRequest.opcRequestId,
+                "opc-cross-region": updateDashboardGroupRequest.opcCrossRegion
+            };
+            const specRetryConfiguration = common.NoRetryConfigurationDetails;
+            const retrier = oci_common_1.GenericRetrier.createPreferredRetrier(this._clientConfiguration ? this._clientConfiguration.retryConfiguration : undefined, updateDashboardGroupRequest.retryConfiguration, specRetryConfiguration);
+            if (this.logger)
+                retrier.logger = this.logger;
+            const request = yield oci_common_1.composeRequest({
+                baseEndpoint: this._endpoint,
+                defaultHeaders: this._defaultHeaders,
+                path: "/dashboardGroups/{dashboardGroupId}",
+                method: "PUT",
+                bodyContent: common.ObjectSerializer.serialize(updateDashboardGroupRequest.updateDashboardGroupDetails, "UpdateDashboardGroupDetails", model.UpdateDashboardGroupDetails.getJsonObj),
+                pathParams: pathParams,
+                headerParams: headerParams,
+                queryParams: queryParams
+            });
+            try {
+                const response = yield retrier.makeServiceCall(this._httpClient, request);
+                const sdkResponse = oci_common_1.composeResponse({
+                    responseObject: {},
+                    body: yield response.json(),
+                    bodyKey: "dashboardGroup",
+                    bodyModel: model.DashboardGroup,
+                    type: "model.DashboardGroup",
+                    responseHeaders: [
+                        {
+                            value: response.headers.get("etag"),
+                            key: "etag",
+                            dataType: "string"
+                        },
+                        {
+                            value: response.headers.get("opc-request-id"),
+                            key: "opcRequestId",
+                            dataType: "string"
+                        }
+                    ]
+                });
+                return sdkResponse;
+            }
+            catch (err) {
+                throw err;
+            }
+        });
+    }
+}
+exports.DashboardGroupClient = DashboardGroupClient;
+DashboardGroupClient.serviceEndpointTemplate = "https://dashboard.{region}.oci.{secondLevelDomain}";
+//# sourceMappingURL=client.js.map