oci-dashboardservice 2.12.1

package/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+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 dashboard_waiter from "./lib/dashboard-waiter";
+import * as dashboardgroup_waiter from "./lib/dashboardgroup-waiter";
+export { models };
+export { requests };
+export { responses };
+export import DashboardClient = client.DashboardClient;
+export import DashboardWaiter = dashboard_waiter.DashboardWaiter;
+export import DashboardGroupClient = client.DashboardGroupClient;
+export import DashboardGroupWaiter = dashboardgroup_waiter.DashboardGroupWaiter;

package/index.js

@@ -0,0 +1,56 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DashboardGroupWaiter = exports.DashboardGroupClient = exports.DashboardWaiter = exports.DashboardClient = 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 dashboard_waiter = __importStar(require("./lib/dashboard-waiter"));
+const dashboardgroup_waiter = __importStar(require("./lib/dashboardgroup-waiter"));
+exports.DashboardClient = client.DashboardClient;
+exports.DashboardWaiter = dashboard_waiter.DashboardWaiter;
+exports.DashboardGroupClient = client.DashboardGroupClient;
+exports.DashboardGroupWaiter = dashboardgroup_waiter.DashboardGroupWaiter;
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/dashboardservice/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;GAmBG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAQjC,4BAAQ;AAPjB,oDAAsC;AAM7B,wBAAM;AALf,0DAA4C;AAOnC,8BAAS;AANlB,qDAAuC;AACvC,yEAA2D;AAC3D,mFAAqE;AAKvD,QAAA,eAAe,GAAG,MAAM,CAAC,eAAe,CAAC;AACzC,QAAA,eAAe,GAAG,gBAAgB,CAAC,eAAe,CAAC;AACnD,QAAA,oBAAoB,GAAG,MAAM,CAAC,oBAAoB,CAAC;AACnD,QAAA,oBAAoB,GAAG,qBAAqB,CAAC,oBAAoB,CAAC"}

package/lib/client.d.ts

@@ -0,0 +1,235 @@
+/**
+ * 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.
+ */
+import common = require("oci-common");
+import * as requests from "./request";
+import * as responses from "./response";
+import { DashboardWaiter } from "./dashboard-waiter";
+import { DashboardGroupWaiter } from "./dashboardgroup-waiter";
+export declare enum 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.
+ */
+export declare class DashboardClient {
+    protected static serviceEndpointTemplate: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": DashboardWaiter;
+    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 DashboardWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): DashboardWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): DashboardWaiter;
+    /**
+     * 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: requests.CreateDashboardRequest): Promise<responses.CreateDashboardResponse>;
+    /**
+     * 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: requests.DeleteDashboardRequest): Promise<responses.DeleteDashboardResponse>;
+    /**
+     * 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: requests.GetDashboardRequest): Promise<responses.GetDashboardResponse>;
+    /**
+     * 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: requests.ListDashboardsRequest): Promise<responses.ListDashboardsResponse>;
+    /**
+     * 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: requests.UpdateDashboardRequest): Promise<responses.UpdateDashboardResponse>;
+}
+export declare enum 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.
+ */
+export declare class DashboardGroupClient {
+    protected static serviceEndpointTemplate: string;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_waiters": DashboardGroupWaiter;
+    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 DashboardGroupWaiter for resources for this service.
+     *
+     * @param config The waiter configuration for termination and delay strategy
+     * @return The service waiters.
+     */
+    createWaiters(config?: common.WaiterConfiguration): DashboardGroupWaiter;
+    /**
+     * Gets the waiters available for resources for this service.
+     *
+     * @return The service waiters.
+     */
+    getWaiters(): DashboardGroupWaiter;
+    /**
+     * 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: requests.CreateDashboardGroupRequest): Promise<responses.CreateDashboardGroupResponse>;
+    /**
+     * 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: requests.DeleteDashboardGroupRequest): Promise<responses.DeleteDashboardGroupResponse>;
+    /**
+     * 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: requests.GetDashboardGroupRequest): Promise<responses.GetDashboardGroupResponse>;
+    /**
+     * 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: requests.ListDashboardGroupsRequest): Promise<responses.ListDashboardGroupsResponse>;
+    /**
+     * 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: requests.UpdateDashboardGroupRequest): Promise<responses.UpdateDashboardGroupResponse>;
+}