@nutanix-scratch/objects-js-client 4.0.1-alpha.2

package/dist/es/Paginable.d.ts

@@ -0,0 +1,95 @@
+/**
+* A model that represents a paginable response from a list endpoint.
+* @module Paginable
+* @version 4.0.1-alpha-2
+*/
+export default class Paginable {
+    /**
+    * Constructs a <code>Paginable</code> from a plain Javascript object, optionally creating a new instance.
+    * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+    * @param {Object} metadata The plain Javascript object bearing properties of interest.
+    * @param {module:Paginable} obj Optional instance to populate.
+    * @return {module:Paginable} The populated <code>Paginable</code> instance.
+    */
+    static constructFromObject(metadata: any, obj: any): any;
+    /**
+    * Get the first page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getFirstPage(): Promise<any>;
+    /**
+    * Get the previous page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getPrevPage(): Promise<any>;
+    /**
+    * Get the next page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getNextPage(): Promise<any>;
+    /**
+    * Get the last page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    getLastPage(): Promise<any>;
+    /**
+    * Get the current page number
+    * @return {Number} the current page number, starts at 0
+    */
+    currentPage(): number;
+    /**
+    * Get the total number of pages
+    * @return {Number} the total number of pages available
+    */
+    countPages(): number;
+    /**
+    * Check if current page is first page
+    * @return {Boolean} True if current page is 0, false otherwise
+    */
+    isFirstPage(): boolean;
+    /**
+    * Check if current page is last page
+    * @return {Boolean} True if current page is countPages()-1, false otherwise
+    */
+    isLastPage(): boolean;
+    populatePaginationMetadata(apiClient: any, page: any, resultsPerPage: any): void;
+    apiClient: ApiClient;
+    page: number;
+    resultsPerPage: number;
+    _getLink(path: any): Promise<any>;
+    /**
+    * The link to first page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkFirst: string;
+    /**
+    * The link to previous page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkPrev: string;
+    /**
+    * The link to next page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkNext: string;
+    /**
+    * The link to last page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkLast: string;
+    /**
+    * Number of total results available
+    * @type {Number}
+    * @memberOf Paginable
+    */
+    resultsTotal: number;
+}
+import { ApiClient } from "./ApiClient";

package/dist/es/Paginable.js

@@ -0,0 +1,287 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = require("./ApiClient");
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /*
+ * Nutanix Objects Storage Management APIs
+ *
+ * OpenAPI spec version: 4.0.1-alpha-2
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 16.8.0.7344-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+* A model that represents a paginable response from a list endpoint.
+* @module Paginable
+* @version 4.0.1-alpha-2
+*/
+var Paginable = exports["default"] = /*#__PURE__*/function () {
+  /**
+  * Constructs a new <code>Paginable</code>.
+  * @alias module:Paginable
+  * @class
+  */
+  function Paginable() {
+    _classCallCheck(this, Paginable);
+  }
+
+  /**
+  * Constructs a <code>Paginable</code> from a plain Javascript object, optionally creating a new instance.
+  * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+  * @param {Object} metadata The plain Javascript object bearing properties of interest.
+  * @param {module:Paginable} obj Optional instance to populate.
+  * @return {module:Paginable} The populated <code>Paginable</code> instance.
+  */
+  return _createClass(Paginable, [{
+    key: "getFirstPage",
+    value:
+    /**
+    * Get the first page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+    function getFirstPage() {
+      if (this.isFirstPage()) {
+        return Promise.reject('Cannot navigate to first page : already on first page');
+      }
+      if (this.linkFirst === null) {
+        return Promise.reject('No link to first page provided in previous API response');
+      }
+      return this._getLink(this.linkFirst);
+    }
+
+    /**
+    * Get the previous page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+  }, {
+    key: "getPrevPage",
+    value: function getPrevPage() {
+      if (this.isFirstPage()) {
+        return Promise.reject('Cannot navigate to previous page : already on first page');
+      }
+      if (this.linkPrev === null) {
+        return Promise.reject('No link to previous page provided in previous API response');
+      }
+      return this._getLink(this.linkPrev);
+    }
+
+    /**
+    * Get the next page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+  }, {
+    key: "getNextPage",
+    value: function getNextPage() {
+      if (this.isLastPage()) {
+        return Promise.reject('Cannot navigate to next page : already on last page');
+      }
+      if (this.linkNext === null) {
+        return Promise.reject('No link to next page provided in previous API response');
+      }
+      return this._getLink(this.linkNext);
+    }
+
+    /**
+    * Get the last page of the set, if any
+    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+    *                   or rejects with error message if any issue (link not available, ...)
+    */
+  }, {
+    key: "getLastPage",
+    value: function getLastPage() {
+      if (this.isLastPage()) {
+        return Promise.reject('Cannot navigate to last page : already on last page');
+      }
+      if (this.linkLast === null) {
+        return Promise.reject('No link to last page provided in previous API response');
+      }
+      return this._getLink(this.linkLast);
+    }
+
+    /**
+    * Get the current page number
+    * @return {Number} the current page number, starts at 0
+    */
+  }, {
+    key: "currentPage",
+    value: function currentPage() {
+      if (this.page === null) {
+        return 0;
+      }
+      return this.page;
+    }
+
+    /**
+    * Get the total number of pages
+    * @return {Number} the total number of pages available
+    */
+  }, {
+    key: "countPages",
+    value: function countPages() {
+      if (this.resultsPerPage === null || this.resultsTotal === null || this.resultsPerPage === 0) {
+        return 1;
+      }
+      return Math.ceil(this.resultsTotal / this.resultsPerPage);
+    }
+
+    /**
+    * Check if current page is first page
+    * @return {Boolean} True if current page is 0, false otherwise
+    */
+  }, {
+    key: "isFirstPage",
+    value: function isFirstPage() {
+      return this.currentPage() === 0;
+    }
+
+    /**
+    * Check if current page is last page
+    * @return {Boolean} True if current page is countPages()-1, false otherwise
+    */
+  }, {
+    key: "isLastPage",
+    value: function isLastPage() {
+      return this.currentPage() === this.countPages() - 1;
+    }
+  }, {
+    key: "populatePaginationMetadata",
+    value: function populatePaginationMetadata(apiClient, page, resultsPerPage) {
+      this.apiClient = apiClient;
+      this.page = page;
+      this.resultsPerPage = resultsPerPage;
+    }
+  }, {
+    key: "_getLink",
+    value: function _getLink(path) {
+      // If no ApiClient defined, instantiate default one
+      if (this.apiClient === null) {
+        this.apiClient = _ApiClient.ApiClient.instance;
+      }
+      var postBody = {};
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = this.constructor;
+      return this.apiClient.callApi(path, 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+  }], [{
+    key: "constructFromObject",
+    value: function constructFromObject(metadata, obj) {
+      if (metadata) {
+        obj = obj || new Paginable();
+        if (metadata.hasOwnProperty('links') && metadata['links'] !== null && metadata['links'] !== undefined) {
+          var _iterator = _createForOfIteratorHelper(metadata['links']),
+            _step;
+          try {
+            for (_iterator.s(); !(_step = _iterator.n()).done;) {
+              var link = _step.value;
+              if (link.hasOwnProperty('rel') && link.hasOwnProperty('href')) {
+                switch (link['rel']) {
+                  case 'first':
+                    obj.linkFirst = link['href'];
+                    break;
+                  case 'prev':
+                    obj.linkPrev = link['href'];
+                    break;
+                  case 'next':
+                    obj.linkNext = link['href'];
+                    break;
+                  case 'last':
+                    obj.linkLast = link['href'];
+                    break;
+                  default:
+                    break;
+                }
+              }
+            }
+          } catch (err) {
+            _iterator.e(err);
+          } finally {
+            _iterator.f();
+          }
+        }
+        if (metadata.hasOwnProperty('totalAvailableResults')) {
+          obj.resultsTotal = metadata['totalAvailableResults'];
+        }
+      }
+      return obj;
+    }
+  }]);
+}();
+/**
+* The link to first page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkFirst = null;
+
+/**
+* The link to previous page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkPrev = null;
+
+/**
+* The link to next page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkNext = null;
+
+/**
+* The link to last page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkLast = null;
+
+/**
+* The ApiClient instance to use for further query
+* @type {ApiClient}
+* @memberOf Paginable
+*/
+Paginable.prototype.apiClient = null;
+
+/**
+* Current page number
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.page = null;
+
+/**
+* Number of results per page
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.resultsPerPage = null;
+
+/**
+* Number of total results available
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.resultsTotal = null;

package/dist/es/apis/objectstores-endpoints.d.ts

@@ -0,0 +1,231 @@
+/**
+ * ObjectStores service.
+ * @version 4.0.1-alpha-2
+ * @class ObjectStoresApi
+ */
+export class ObjectStoresApi {
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    static get ApiClient(): typeof ApiClient;
+    /**
+     * Constructs a new ObjectStoresApi.
+     * @alias module:api/ObjectStoresApi
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Create a SSL certificate for an Object store
+     * This operation creates a new default certificate and keys. It also creates the alternate FQDNs for the Object store. The certificate of an Object store can be created when it is in a OBJECT_STORE_AVAILABLE or OBJECT_STORE_CREATE_CERT_ERROR state. If the publicCert, privateKey, and ca values are provided in the request body, these values are used to create the new certificate. If these values are not provided, they will be generated for the new certificate. Optionally, a list of additional alternate FQDNs can be provided.
+     * @param { String } objectStoreExtId The UUID of the Object store.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.publicCert
+     * @param { String } opts.privateKey
+     * @param { common.v1.config.Metadata } opts.metadata
+     * @param { Array } opts.alternateFqdns
+     * @param { String } opts.tenantId
+     * @param { Array } opts.links
+     * @param { String } opts.extId
+     * @param { String } opts.ca
+     * @param {Object} args Additional Arguments
+     * @return {Promise<TaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link TaskReferenceApiResponse } and HTTP response
+     */
+    createCertificate(objectStoreExtId: string, opts: {
+        publicCert: string;
+        privateKey: string;
+        metadata: common.v1.config.Metadata;
+        alternateFqdns: any[];
+        tenantId: string;
+        links: any[];
+        extId: string;
+        ca: string;
+    }, ...args: any): Promise<TaskReferenceApiResponse>;
+    /**
+     * Create an Object store
+     * Run the prechecks, create and start the deployment of an Object store on Prism Central.
+     * @param { Required<Pick<Objectstore, 'name'>> & Partial<Objectstore> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<TaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link TaskReferenceApiResponse } and HTTP response
+     */
+    createObjectstore(body: Required<Pick<Objectstore, 'name'>> & Partial<Objectstore>, ...args: any): Promise<TaskReferenceApiResponse>;
+    /**
+     * Delete an Object store
+     * Send a request to delete an Object store for the provided UUID and clean up its data. An Object store can only be deleted when it is in the state OBJECT_STORE_INPUT, OBJECT_STORE_DELETE_INPUT_ERROR, OBJECT_STORE_AVAILABLE, OBJECT_STORE_DEPLOYMENT_ERROR or OBJECT_STORE_DELETE_ERROR and does not contain any buckets.
+     * @param { String } extId The UUID of the Object store.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<TaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link TaskReferenceApiResponse } and HTTP response
+     */
+    deleteObjectstore(extId: string, ...args: any): Promise<TaskReferenceApiResponse>;
+    /**
+     * Get the details of an Object store certificate
+     * Get the details of the SSL certificate which can be used to connect to an Object store.
+     * @param { String } objectStoreExtId The UUID of the Object store.
+     * @param { String } extId The UUID of the certificate of an Object store.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CertificateApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CertificateApiResponse } and HTTP response
+     */
+    getCertificate(objectStoreExtId: string, extId: string, ...args: any): Promise<CertificateApiResponse>;
+    /**
+     * Get a list of the SSL certificates of an Object store
+     * Get a list of the SSL certificates which can be used to access an Object store.
+     * @param { String } objectStoreExtId The UUID of the Object store.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - ca
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - ca
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+- alternateFqdns
+- ca
+- extId
+- links
+- metadata
+- privateKey
+- publicCert
+- tenantId
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CertificateListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CertificateListApiResponse } and HTTP response
+     */
+    getCertificates(objectStoreExtId: string, opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<CertificateListApiResponse>;
+    /**
+     * Get an Object store
+     * Get an Object store for the provided UUID.      &#x60;state&#x60;   string (State of the Object store)   Enum for the state of the Object store.   | Enum | Description | | ----------- | ----------- | | &#x60;\&quot;OBJECT_STORE_DEPLOYING\&quot;&#x60; | The Object store will be in this state during an ongoing deployment of the Object store. The Object store will be unavailable through S3 APIs in this state. The Object store will move to the OBJECT_STORE_AVAILABLE state if the deployment succeeds, and to the OBJECT_STORE_DEPLOYMENT_ERROR state if the deployment fails. | | &#x60;\&quot;OBJECT_STORE_OPERATION_ERROR\&quot;&#x60; | The Object store is in this state when there is an error while performing an operation on the Object store. The Object store may not be available through S3 APIs in this state. | | &#x60;\&quot;OBJECT_STORE_CREATE_CERT_ERROR\&quot;&#x60; |  An Object store enters this state if there is an error while creating the Object store certificate. Creating a new certificate can be retried from this state. The Object store may not be available through S3 APIs in this state. | | &#x60;\&quot;OBJECT_STORE_OPERATION_PENDING\&quot;&#x60; |  The Object store is in this state during an ongoing operation on the Object store. The Object store may not be available through S3 APIs in this state. The Object store will enter the OBJECT_STORE_OPERATION_ERROR state if the operation fails, or the OBJECT_STORE_AVAILABLE state if the operation is successful. | | &#x60;\&quot;OBJECT_STORE_INPUT\&quot;&#x60; |  The Object store is in this state if it has not been deployed. | | &#x60;\&quot;OBJECT_STORE_CREATING_CERT\&quot;&#x60; |  The Object store is in this state during a certificate creation for the Object store. The Object store will be unavailable through S3 APIs in this state. It will move to the OBJECT_STORE_AVAILABLE state if the certificate was created successfully, or to the OBJECT_STORE_CREATE_CERT_ERROR state if an error occurs while creating the certificate. | | &#x60;\&quot;OBJECT_STORE_AVAILABLE\&quot;&#x60;  | An Object store is in this state if its deployment was successful, and there are no ongoing operations on the Object store. The Object store will be available through S3 APIs in this state. In this state, the Object store can be deleted or a new certificate can be created for this Object store. | | &#x60;\&quot;OBJECT_STORE_DELETE_INPUT_ERROR\&quot;&#x60; |  An undeployed Object store enters this state if there is an error deleting it. Deleting the Object store can be retried from this state. | | &#x60;\&quot;OBJECT_STORE_DELETING_INPUT\&quot;&#x60; |  An undeployed Object store being deleted is in this state. It will be either deleted or move to the OBJECT_STORE_DELETE_INPUT_ERROR state if the deletion fails. | | &#x60;\&quot;OBJECT_STORE_DELETE_ERROR\&quot;&#x60; |  An Object store enters this state if there is an error deleting the Object store. The Object store will not be available through S3 APIs in this state. Deleting the Object store can be retried from this state. | | &#x60;\&quot;OBJECT_STORE_DEPLOYMENT_ERROR\&quot;&#x60; |  An Object store enters this state when its deployment fails. The Object store deployment can be retried or the Object store can be deleted from this state. | | &#x60;\&quot;OBJECT_STORE_DELETING\&quot;&#x60; |  A deployed Object store is in this state when the Object store is being deleted. The Object store will be unavailable through S3 APIs in this state. It can be either deleted or move to the OBJECT_STORE_DELETE_ERROR state if the deletion fails. |
+     * @param { String } extId The UUID of the Object store.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported.
+- certificate
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ObjectstoreApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ObjectstoreApiResponse } and HTTP response
+     */
+    getObjectstore(extId: string, opts: {
+        $expand: string;
+    }, ...args: any): Promise<ObjectstoreApiResponse>;
+    /**
+     * Get a list of the Object stores
+     * Get a list of all the Object store details on the registered Prism Central.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - certificateReference<br>
+     * - clusterReference<br>
+     * - creationTime<br>
+     * - deploymentVersion<br>
+     * - description<br>
+     * - domain<br>
+     * - lastUpdateTime<br>
+     * - name<br>
+     * - numWorkerNodes<br>
+     * - publicNetworkReference<br>
+     * - region<br>
+     * - state<br>
+     * - storageNetworkDnsIp/ipv4/value<br>
+     * - storageNetworkDnsIp/ipv6/value<br>
+     * - storageNetworkReference<br>
+     * - storageNetworkVip/ipv4/value<br>
+     * - storageNetworkVip/ipv6/value<br>
+     * - totalCapacityGiB
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - certificateReference<br>
+     * - clusterReference<br>
+     * - creationTime<br>
+     * - deploymentVersion<br>
+     * - description<br>
+     * - domain<br>
+     * - lastUpdateTime<br>
+     * - name<br>
+     * - numWorkerNodes<br>
+     * - publicNetworkReference<br>
+     * - region<br>
+     * - state<br>
+     * - storageNetworkDnsIp/ipv4/value<br>
+     * - storageNetworkDnsIp/ipv6/value<br>
+     * - storageNetworkReference<br>
+     * - storageNetworkVip/ipv4/value<br>
+     * - storageNetworkVip/ipv6/value<br>
+     * - totalCapacityGiB
+     * @param { String } opts.$expand A URL query parameter that allows clients to request related resources when a resource that satisfies a particular request is retrieved. Each expanded item is evaluated relative to the entity containing the property being expanded. Other query options can be applied to an expanded property by appending a semicolon-separated list of query options, enclosed in parentheses, to the property name. Permissible system query options are $filter, $select and $orderby. The following expansion keys are supported.
+- certificate
+
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+- certificateReference
+- clusterReference
+- creationTime
+- deploymentVersion
+- description
+- domain
+- extId
+- lastUpdateTime
+- links
+- metadata
+- name
+- numWorkerNodes
+- publicNetworkIps
+- publicNetworkReference
+- region
+- state
+- storageNetworkDnsIp/ipv4/prefixLength
+- storageNetworkDnsIp/ipv4/value
+- storageNetworkDnsIp/ipv6/prefixLength
+- storageNetworkDnsIp/ipv6/value
+- storageNetworkReference
+- storageNetworkVip/ipv4/prefixLength
+- storageNetworkVip/ipv4/value
+- storageNetworkVip/ipv6/prefixLength
+- storageNetworkVip/ipv6/value
+- tenantId
+- totalCapacityGiB
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ObjectstoreListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ObjectstoreListApiResponse } and HTTP response
+     */
+    getObjectstores(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $expand: string;
+        $select: string;
+    }, ...args: any): Promise<ObjectstoreListApiResponse>;
+    /**
+     * Update an Object store
+     * Update an Object store. The deployment of an Object store can be restarted from the state OBJECT_STORE_DEPLOYMENT_ERROR.
+     * @param { Required<Pick<Objectstore, 'name'>> & Partial<Objectstore> } body specification
+     * @param { String } extId The UUID of the Object store.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<TaskReferenceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link TaskReferenceApiResponse } and HTTP response
+     */
+    updateObjectstore(extId: string, body: Required<Pick<Objectstore, 'name'>> & Partial<Objectstore>, ...args: any): Promise<TaskReferenceApiResponse>;
+    #private;
+}
+import TaskReferenceApiResponse from "../models/objects/v4/operations/TaskReferenceApiResponse";
+import Objectstore from "../models/objects/v4/operations/Objectstore";
+import CertificateApiResponse from "../models/objects/v4/operations/CertificateApiResponse";
+import CertificateListApiResponse from "../models/objects/v4/operations/CertificateListApiResponse";
+import ObjectstoreApiResponse from "../models/objects/v4/operations/ObjectstoreApiResponse";
+import ObjectstoreListApiResponse from "../models/objects/v4/operations/ObjectstoreListApiResponse";
+import { ApiClient } from "../ApiClient";