@nutanix-scratch/objects-js-client 4.0.1-alpha.2 → 4.0.1-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.txt +202 -49
- package/README.md +39 -27
- package/dist/Ntnx-Objects-js-client-prod.js +1 -1
- package/dist/Ntnx-Objects-js-client.js +151 -86
- package/dist/es/ApiClient.d.ts +8 -1
- package/dist/es/ApiClient.js +248 -188
- package/dist/es/Paginable.d.ts +1 -1
- package/dist/es/Paginable.js +9 -9
- package/dist/es/apis/objectstores-endpoints.d.ts +63 -95
- package/dist/es/apis/objectstores-endpoints.js +198 -166
- package/dist/es/index.d.ts +31 -21
- package/dist/es/index.js +89 -49
- package/dist/es/models/common/v1/config/FQDN.d.ts +24 -20
- package/dist/es/models/common/v1/config/FQDN.js +56 -21
- package/dist/es/models/common/v1/config/Flag.d.ts +32 -26
- package/dist/es/models/common/v1/config/Flag.js +65 -21
- package/dist/es/models/common/v1/config/IPAddress.d.ts +42 -26
- package/dist/es/models/common/v1/config/IPAddress.js +53 -21
- package/dist/es/models/common/v1/config/IPv4Address.d.ts +40 -26
- package/dist/es/models/common/v1/config/IPv4Address.js +64 -23
- package/dist/es/models/common/v1/config/IPv6Address.d.ts +40 -26
- package/dist/es/models/common/v1/config/IPv6Address.js +64 -23
- package/dist/es/models/common/v1/config/KVPair.d.ts +35 -26
- package/dist/es/models/common/v1/config/KVPair.js +70 -24
- package/dist/es/models/common/v1/config/MapOfStringWrapper.d.ts +58 -0
- package/dist/es/models/common/v1/config/MapOfStringWrapper.js +275 -0
- package/dist/es/models/common/v1/config/Message.d.ts +41 -38
- package/dist/es/models/common/v1/config/Message.js +57 -25
- package/dist/es/models/common/v1/config/MessageSeverity.js +7 -7
- package/dist/es/models/common/v1/config/Metadata.d.ts +46 -44
- package/dist/es/models/common/v1/config/Metadata.js +65 -27
- package/dist/es/models/common/v1/config/TenantAwareModel.d.ts +22 -20
- package/dist/es/models/common/v1/config/TenantAwareModel.js +51 -19
- package/dist/es/models/common/v1/response/ApiLink.d.ts +28 -26
- package/dist/es/models/common/v1/response/ApiLink.js +53 -21
- package/dist/es/models/common/v1/response/ApiResponseMetadata.d.ts +79 -44
- package/dist/es/models/common/v1/response/ApiResponseMetadata.js +71 -27
- package/dist/es/models/common/v1/response/ExternalizableAbstractModel.d.ts +24 -18
- package/dist/es/models/common/v1/response/ExternalizableAbstractModel.js +71 -31
- package/dist/es/models/objects/v4/config/Certificate.d.ts +99 -0
- package/dist/es/models/objects/v4/{operations → config}/Certificate.js +89 -42
- package/dist/es/models/objects/v4/{operations → config}/CertificateProjection.d.ts +2 -1
- package/dist/{lib/models/objects/v4/operations → es/models/objects/v4/config}/CertificateProjection.js +40 -17
- package/dist/es/models/objects/v4/config/CreateCertificateApiResponse.d.ts +99 -0
- package/dist/es/models/objects/v4/config/CreateCertificateApiResponse.js +343 -0
- package/dist/es/models/objects/v4/config/CreateObjectstoreApiResponse.d.ts +99 -0
- package/dist/{lib/models/objects/v4/operations/TaskReferenceApiResponse.js → es/models/objects/v4/config/CreateObjectstoreApiResponse.js} +86 -54
- package/dist/es/models/objects/v4/config/DeleteObjectstoreApiResponse.d.ts +99 -0
- package/dist/es/models/objects/v4/config/DeleteObjectstoreApiResponse.js +343 -0
- package/dist/es/models/objects/v4/config/GetCaApiResponse.d.ts +100 -0
- package/dist/es/models/objects/v4/{operations/TaskReferenceApiResponse.js → config/GetCaApiResponse.js} +88 -57
- package/dist/es/models/objects/v4/config/GetCertificateApiResponse.d.ts +99 -0
- package/dist/es/models/objects/v4/{operations/CertificateApiResponse.js → config/GetCertificateApiResponse.js} +88 -56
- package/dist/es/models/objects/v4/config/GetObjectstoreApiResponse.d.ts +99 -0
- package/dist/{lib/models/objects/v4/operations/ObjectstoreApiResponse.js → es/models/objects/v4/config/GetObjectstoreApiResponse.js} +89 -57
- package/dist/es/models/objects/v4/config/ListCertificatesApiResponse.d.ts +100 -0
- package/dist/es/models/objects/v4/{operations/CertificateListApiResponse.js → config/ListCertificatesApiResponse.js} +89 -57
- package/dist/es/models/objects/v4/config/ListObjectstoresApiResponse.d.ts +100 -0
- package/dist/es/models/objects/v4/{operations/ObjectstoreListApiResponse.js → config/ListObjectstoresApiResponse.js} +92 -60
- package/dist/es/models/objects/v4/config/ObjectStore.d.ts +313 -0
- package/dist/es/models/objects/v4/{operations/Objectstore.js → config/ObjectStore.js} +213 -157
- package/dist/es/models/objects/v4/config/ObjectStoreProjection.d.ts +151 -0
- package/dist/{lib/models/objects/v4/operations/ObjectstoreProjection.js → es/models/objects/v4/config/ObjectStoreProjection.js} +211 -65
- package/dist/es/models/objects/v4/{operations/StateEnum.d.ts → config/State.d.ts} +6 -6
- package/dist/es/models/objects/v4/config/State.js +133 -0
- package/dist/es/models/objects/v4/config/UpdateObjectstoreApiResponse.d.ts +99 -0
- package/dist/es/models/objects/v4/config/UpdateObjectstoreApiResponse.js +343 -0
- package/dist/es/models/objects/v4/error/AppMessage.d.ts +57 -48
- package/dist/es/models/objects/v4/error/AppMessage.js +61 -29
- package/dist/es/models/objects/v4/error/ErrorResponse.d.ts +23 -19
- package/dist/es/models/objects/v4/error/ErrorResponse.js +61 -25
- package/dist/es/models/objects/v4/error/SchemaValidationError.d.ts +53 -43
- package/dist/es/models/objects/v4/error/SchemaValidationError.js +62 -29
- package/dist/es/models/objects/v4/error/SchemaValidationErrorMessage.d.ts +34 -32
- package/dist/es/models/objects/v4/error/SchemaValidationErrorMessage.js +55 -23
- package/dist/es/models/prism/v4/config/TaskReference.d.ts +24 -22
- package/dist/es/models/prism/v4/config/TaskReference.js +58 -23
- package/dist/es/models/validation/ValidationError.js +5 -5
- package/dist/es/utils/ValidationUtils.js +5 -5
- package/dist/lib/ApiClient.d.ts +8 -1
- package/dist/lib/ApiClient.js +248 -188
- package/dist/lib/Paginable.d.ts +1 -1
- package/dist/lib/Paginable.js +9 -9
- package/dist/lib/apis/objectstores-endpoints.d.ts +63 -95
- package/dist/lib/apis/objectstores-endpoints.js +198 -166
- package/dist/lib/index.d.ts +31 -21
- package/dist/lib/index.js +89 -49
- package/dist/lib/models/common/v1/config/FQDN.d.ts +24 -20
- package/dist/lib/models/common/v1/config/FQDN.js +56 -21
- package/dist/lib/models/common/v1/config/Flag.d.ts +32 -26
- package/dist/lib/models/common/v1/config/Flag.js +65 -21
- package/dist/lib/models/common/v1/config/IPAddress.d.ts +42 -26
- package/dist/lib/models/common/v1/config/IPAddress.js +53 -21
- package/dist/lib/models/common/v1/config/IPv4Address.d.ts +40 -26
- package/dist/lib/models/common/v1/config/IPv4Address.js +64 -23
- package/dist/lib/models/common/v1/config/IPv6Address.d.ts +40 -26
- package/dist/lib/models/common/v1/config/IPv6Address.js +64 -23
- package/dist/lib/models/common/v1/config/KVPair.d.ts +35 -26
- package/dist/lib/models/common/v1/config/KVPair.js +70 -24
- package/dist/lib/models/common/v1/config/MapOfStringWrapper.d.ts +58 -0
- package/dist/lib/models/common/v1/config/MapOfStringWrapper.js +275 -0
- package/dist/lib/models/common/v1/config/Message.d.ts +41 -38
- package/dist/lib/models/common/v1/config/Message.js +57 -25
- package/dist/lib/models/common/v1/config/MessageSeverity.js +7 -7
- package/dist/lib/models/common/v1/config/Metadata.d.ts +46 -44
- package/dist/lib/models/common/v1/config/Metadata.js +65 -27
- package/dist/lib/models/common/v1/config/TenantAwareModel.d.ts +22 -20
- package/dist/lib/models/common/v1/config/TenantAwareModel.js +51 -19
- package/dist/lib/models/common/v1/response/ApiLink.d.ts +28 -26
- package/dist/lib/models/common/v1/response/ApiLink.js +53 -21
- package/dist/lib/models/common/v1/response/ApiResponseMetadata.d.ts +79 -44
- package/dist/lib/models/common/v1/response/ApiResponseMetadata.js +71 -27
- package/dist/lib/models/common/v1/response/ExternalizableAbstractModel.d.ts +24 -18
- package/dist/lib/models/common/v1/response/ExternalizableAbstractModel.js +71 -31
- package/dist/lib/models/objects/v4/config/Certificate.d.ts +99 -0
- package/dist/lib/models/objects/v4/{operations → config}/Certificate.js +89 -42
- package/dist/lib/models/objects/v4/{operations → config}/CertificateProjection.d.ts +2 -1
- package/dist/{es/models/objects/v4/operations → lib/models/objects/v4/config}/CertificateProjection.js +40 -17
- package/dist/lib/models/objects/v4/config/CreateCertificateApiResponse.d.ts +99 -0
- package/dist/lib/models/objects/v4/config/CreateCertificateApiResponse.js +343 -0
- package/dist/lib/models/objects/v4/config/CreateObjectstoreApiResponse.d.ts +99 -0
- package/dist/lib/models/objects/v4/config/CreateObjectstoreApiResponse.js +343 -0
- package/dist/lib/models/objects/v4/config/DeleteObjectstoreApiResponse.d.ts +99 -0
- package/dist/lib/models/objects/v4/config/DeleteObjectstoreApiResponse.js +343 -0
- package/dist/lib/models/objects/v4/config/GetCaApiResponse.d.ts +100 -0
- package/dist/lib/models/objects/v4/{operations/CertificateApiResponse.js → config/GetCaApiResponse.js} +88 -57
- package/dist/lib/models/objects/v4/config/GetCertificateApiResponse.d.ts +99 -0
- package/dist/lib/models/objects/v4/config/GetCertificateApiResponse.js +343 -0
- package/dist/lib/models/objects/v4/config/GetObjectstoreApiResponse.d.ts +99 -0
- package/dist/{es/models/objects/v4/operations/ObjectstoreApiResponse.js → lib/models/objects/v4/config/GetObjectstoreApiResponse.js} +89 -57
- package/dist/lib/models/objects/v4/config/ListCertificatesApiResponse.d.ts +100 -0
- package/dist/lib/models/objects/v4/{operations/CertificateListApiResponse.js → config/ListCertificatesApiResponse.js} +89 -57
- package/dist/lib/models/objects/v4/config/ListObjectstoresApiResponse.d.ts +100 -0
- package/dist/lib/models/objects/v4/{operations/ObjectstoreListApiResponse.js → config/ListObjectstoresApiResponse.js} +92 -60
- package/dist/lib/models/objects/v4/config/ObjectStore.d.ts +313 -0
- package/dist/lib/models/objects/v4/{operations/Objectstore.js → config/ObjectStore.js} +213 -157
- package/dist/lib/models/objects/v4/config/ObjectStoreProjection.d.ts +151 -0
- package/dist/{es/models/objects/v4/operations/ObjectstoreProjection.js → lib/models/objects/v4/config/ObjectStoreProjection.js} +211 -65
- package/dist/lib/models/objects/v4/{operations/StateEnum.d.ts → config/State.d.ts} +6 -6
- package/dist/lib/models/objects/v4/config/State.js +133 -0
- package/dist/lib/models/objects/v4/config/UpdateObjectstoreApiResponse.d.ts +99 -0
- package/dist/lib/models/objects/v4/config/UpdateObjectstoreApiResponse.js +343 -0
- package/dist/lib/models/objects/v4/error/AppMessage.d.ts +57 -48
- package/dist/lib/models/objects/v4/error/AppMessage.js +61 -29
- package/dist/lib/models/objects/v4/error/ErrorResponse.d.ts +23 -19
- package/dist/lib/models/objects/v4/error/ErrorResponse.js +61 -25
- package/dist/lib/models/objects/v4/error/SchemaValidationError.d.ts +53 -43
- package/dist/lib/models/objects/v4/error/SchemaValidationError.js +62 -29
- package/dist/lib/models/objects/v4/error/SchemaValidationErrorMessage.d.ts +34 -32
- package/dist/lib/models/objects/v4/error/SchemaValidationErrorMessage.js +55 -23
- package/dist/lib/models/prism/v4/config/TaskReference.d.ts +24 -22
- package/dist/lib/models/prism/v4/config/TaskReference.js +58 -23
- package/dist/lib/models/validation/ValidationError.js +5 -5
- package/dist/lib/utils/ValidationUtils.js +5 -5
- package/package.json +1 -1
- package/dist/es/models/objects/v4/operations/Certificate.d.ts +0 -78
- package/dist/es/models/objects/v4/operations/CertificateApiResponse.d.ts +0 -59
- package/dist/es/models/objects/v4/operations/CertificateListApiResponse.d.ts +0 -59
- package/dist/es/models/objects/v4/operations/Objectstore.d.ts +0 -242
- package/dist/es/models/objects/v4/operations/ObjectstoreApiResponse.d.ts +0 -59
- package/dist/es/models/objects/v4/operations/ObjectstoreListApiResponse.d.ts +0 -59
- package/dist/es/models/objects/v4/operations/ObjectstoreProjection.d.ts +0 -50
- package/dist/es/models/objects/v4/operations/StateEnum.js +0 -145
- package/dist/es/models/objects/v4/operations/TaskReferenceApiResponse.d.ts +0 -59
- package/dist/lib/models/objects/v4/operations/Certificate.d.ts +0 -78
- package/dist/lib/models/objects/v4/operations/CertificateApiResponse.d.ts +0 -59
- package/dist/lib/models/objects/v4/operations/CertificateListApiResponse.d.ts +0 -59
- package/dist/lib/models/objects/v4/operations/Objectstore.d.ts +0 -242
- package/dist/lib/models/objects/v4/operations/ObjectstoreApiResponse.d.ts +0 -59
- package/dist/lib/models/objects/v4/operations/ObjectstoreListApiResponse.d.ts +0 -59
- package/dist/lib/models/objects/v4/operations/ObjectstoreProjection.d.ts +0 -50
- package/dist/lib/models/objects/v4/operations/StateEnum.js +0 -145
- package/dist/lib/models/objects/v4/operations/TaskReferenceApiResponse.d.ts +0 -59
package/dist/es/Paginable.js
CHANGED
|
@@ -6,21 +6,21 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports["default"] = void 0;
|
|
7
7
|
var _ApiClient = require("./ApiClient");
|
|
8
8
|
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); }
|
|
9
|
-
function _createForOfIteratorHelper(
|
|
10
|
-
function _unsupportedIterableToArray(
|
|
11
|
-
function _arrayLikeToArray(
|
|
12
|
-
function _classCallCheck(
|
|
13
|
-
function _defineProperties(
|
|
14
|
-
function _createClass(
|
|
9
|
+
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, 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 o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
|
|
10
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
11
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
12
|
+
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
|
|
13
|
+
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
|
|
14
|
+
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
|
|
15
15
|
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
|
|
16
16
|
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); } /*
|
|
17
17
|
* Nutanix Objects Storage Management APIs
|
|
18
18
|
*
|
|
19
|
-
* OpenAPI spec version: 4.0.1-
|
|
19
|
+
* OpenAPI spec version: 4.0.1-beta-1
|
|
20
20
|
*
|
|
21
21
|
* NOTE: This class is auto generated by the Open API Dev Platform.
|
|
22
22
|
*
|
|
23
|
-
* Open API Dev Platform Codegen version: 16.
|
|
23
|
+
* Open API Dev Platform Codegen version: 16.9.0.8546-RELEASE
|
|
24
24
|
*
|
|
25
25
|
* Do not edit the class manually.
|
|
26
26
|
*
|
|
@@ -28,7 +28,7 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
|
|
|
28
28
|
/**
|
|
29
29
|
* A model that represents a paginable response from a list endpoint.
|
|
30
30
|
* @module Paginable
|
|
31
|
-
* @version 4.0.1-
|
|
31
|
+
* @version 4.0.1-beta-1
|
|
32
32
|
*/
|
|
33
33
|
var Paginable = exports["default"] = /*#__PURE__*/function () {
|
|
34
34
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* ObjectStores service.
|
|
3
|
-
* @version 4.0.1-
|
|
3
|
+
* @version 4.0.1-beta-1
|
|
4
4
|
* @class ObjectStoresApi
|
|
5
5
|
*/
|
|
6
6
|
export class ObjectStoresApi {
|
|
@@ -20,55 +20,55 @@ export class ObjectStoresApi {
|
|
|
20
20
|
apiClient: any;
|
|
21
21
|
/**
|
|
22
22
|
* Create a SSL certificate for an Object store
|
|
23
|
-
* 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
|
|
23
|
+
* 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_CERT_CREATION_FAILED 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, the existing certificate will be used as the new certificate. Optionally, a list of additional alternate FQDNs can be provided.
|
|
24
|
+
* @param { Partial<String | ReadableStream> } body Accepts file path as a string or a file stream
|
|
24
25
|
* @param { String } objectStoreExtId The UUID of the Object store.
|
|
25
|
-
* @param {Object} opts Optional parameters defined for the operation
|
|
26
|
-
* @param { String } opts.publicCert
|
|
27
|
-
* @param { String } opts.privateKey
|
|
28
|
-
* @param { common.v1.config.Metadata } opts.metadata
|
|
29
|
-
* @param { Array } opts.alternateFqdns
|
|
30
|
-
* @param { String } opts.tenantId
|
|
31
|
-
* @param { Array } opts.links
|
|
32
|
-
* @param { String } opts.extId
|
|
33
|
-
* @param { String } opts.ca
|
|
34
26
|
* @param {Object} args Additional Arguments
|
|
35
|
-
* @return {Promise<
|
|
27
|
+
* @return {Promise<CreateCertificateApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateCertificateApiResponse } and HTTP response
|
|
36
28
|
*/
|
|
37
|
-
createCertificate(objectStoreExtId: string,
|
|
38
|
-
publicCert: string;
|
|
39
|
-
privateKey: string;
|
|
40
|
-
metadata: common.v1.config.Metadata;
|
|
41
|
-
alternateFqdns: any[];
|
|
42
|
-
tenantId: string;
|
|
43
|
-
links: any[];
|
|
44
|
-
extId: string;
|
|
45
|
-
ca: string;
|
|
46
|
-
}, ...args: any): Promise<TaskReferenceApiResponse>;
|
|
29
|
+
createCertificate(objectStoreExtId: string, body: Partial<string | ReadableStream<any>>, ...args: any): Promise<CreateCertificateApiResponse>;
|
|
47
30
|
/**
|
|
48
31
|
* Create an Object store
|
|
49
32
|
* Run the prechecks, create and start the deployment of an Object store on Prism Central.
|
|
50
|
-
* @param { Required<Pick<
|
|
33
|
+
* @param { Required<Pick<ObjectStore, 'name'>> & Partial<ObjectStore> } body specification
|
|
51
34
|
* @param {Object} args Additional Arguments
|
|
52
|
-
* @return {Promise<
|
|
35
|
+
* @return {Promise<CreateObjectstoreApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateObjectstoreApiResponse } and HTTP response
|
|
53
36
|
*/
|
|
54
|
-
createObjectstore(body: Required<Pick<
|
|
37
|
+
createObjectstore(body: Required<Pick<ObjectStore, 'name'>> & Partial<ObjectStore>, ...args: any): Promise<CreateObjectstoreApiResponse>;
|
|
55
38
|
/**
|
|
56
39
|
* Delete an Object store
|
|
57
|
-
* 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
|
|
40
|
+
* 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 UNDEPLOYED_OBJECT_STORE, OBJECT_STORE_AVAILABLE, OBJECT_STORE_DEPLOYMENT_FAILED or OBJECT_STORE_DELETION_FAILED and does not contain any buckets.
|
|
58
41
|
* @param { String } extId The UUID of the Object store.
|
|
59
42
|
* @param {Object} args Additional Arguments
|
|
60
|
-
* @return {Promise<
|
|
43
|
+
* @return {Promise<DeleteObjectstoreApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteObjectstoreApiResponse } and HTTP response
|
|
61
44
|
*/
|
|
62
|
-
|
|
45
|
+
deleteObjectstoreById(extId: string, ...args: any): Promise<DeleteObjectstoreApiResponse>;
|
|
46
|
+
/**
|
|
47
|
+
* Download the certificate authority
|
|
48
|
+
* Download the certificate authority of an Object store certificate.
|
|
49
|
+
* @param { String } objectStoreExtId The UUID of the Object store.
|
|
50
|
+
* @param { String } extId The UUID of the certificate of an Object store.
|
|
51
|
+
* @param {Object} args Additional Arguments
|
|
52
|
+
* @return {Promise<GetCaApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetCaApiResponse } and HTTP response
|
|
53
|
+
*/
|
|
54
|
+
getCaByCertificateId(objectStoreExtId: string, extId: string, ...args: any): Promise<GetCaApiResponse>;
|
|
63
55
|
/**
|
|
64
56
|
* Get the details of an Object store certificate
|
|
65
57
|
* Get the details of the SSL certificate which can be used to connect to an Object store.
|
|
66
58
|
* @param { String } objectStoreExtId The UUID of the Object store.
|
|
67
59
|
* @param { String } extId The UUID of the certificate of an Object store.
|
|
68
60
|
* @param {Object} args Additional Arguments
|
|
69
|
-
* @return {Promise<
|
|
61
|
+
* @return {Promise<GetCertificateApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetCertificateApiResponse } and HTTP response
|
|
62
|
+
*/
|
|
63
|
+
getCertificateById(objectStoreExtId: string, extId: string, ...args: any): Promise<GetCertificateApiResponse>;
|
|
64
|
+
/**
|
|
65
|
+
* Get an Object store
|
|
66
|
+
* Get an Object store for the provided UUID. `state` string (State of the Object store) Enum for the state of the Object store. | Enum | Description | | ----------- | ----------- | | `\"DEPLOYING_OBJECT_STORE\"` | 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_FAILED state if the deployment fails. | | `\"OBJECT_STORE_OPERATION_FAILED\"` | 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. | | `\"OBJECT_STORE_CERT_CREATION_FAILED\"` | 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. | | `\"OBJECT_STORE_OPERATION_PENDING\"` | 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_FAILED state if the operation fails, or the OBJECT_STORE_AVAILABLE state if the operation is successful. | | `\"UNDEPLOYED_OBJECT_STORE\"` | The Object store is in this state if it has not been deployed. | | `\"CREATING_OBJECT_STORE_CERT\"` | 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_CERT_CREATION_FAILED state if an error occurs while creating the certificate. | | `\"OBJECT_STORE_AVAILABLE\"` | 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. | | `\"OBJECT_STORE_DELETION_FAILED\"` | 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. | | `\"OBJECT_STORE_DEPLOYMENT_FAILED\"` | 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. | | `\"DELETING_OBJECT_STORE\"` | 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_DELETION_FAILED state if the deletion fails. |
|
|
67
|
+
* @param { String } extId The UUID of the Object store.
|
|
68
|
+
* @param {Object} args Additional Arguments
|
|
69
|
+
* @return {Promise<GetObjectstoreApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetObjectstoreApiResponse } and HTTP response
|
|
70
70
|
*/
|
|
71
|
-
|
|
71
|
+
getObjectstoreById(extId: string, ...args: any): Promise<GetObjectstoreApiResponse>;
|
|
72
72
|
/**
|
|
73
73
|
* Get a list of the SSL certificates of an Object store
|
|
74
74
|
* Get a list of the SSL certificates which can be used to access an Object store.
|
|
@@ -81,44 +81,20 @@ export class ObjectStoresApi {
|
|
|
81
81
|
* @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>
|
|
82
82
|
* 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>
|
|
83
83
|
* The filter can be applied to the following fields:<br>
|
|
84
|
-
* -
|
|
85
|
-
* @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>
|
|
86
|
-
* The orderby can be applied to the following fields:<br>
|
|
87
|
-
* - ca
|
|
84
|
+
* - alternateFqdns/value
|
|
88
85
|
* @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.
|
|
89
86
|
- alternateFqdns
|
|
90
|
-
-
|
|
91
|
-
- extId
|
|
92
|
-
- links
|
|
93
|
-
- metadata
|
|
94
|
-
- privateKey
|
|
95
|
-
- publicCert
|
|
96
|
-
- tenantId
|
|
87
|
+
- alternateFqdns/value
|
|
97
88
|
|
|
98
89
|
* @param {Object} args Additional Arguments
|
|
99
|
-
* @return {Promise<
|
|
90
|
+
* @return {Promise<ListCertificatesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListCertificatesApiResponse } and HTTP response
|
|
100
91
|
*/
|
|
101
|
-
|
|
92
|
+
listCertificatesByObjectstoreId(objectStoreExtId: string, opts: {
|
|
102
93
|
$page: number;
|
|
103
94
|
$limit: number;
|
|
104
95
|
$filter: string;
|
|
105
|
-
$orderby: string;
|
|
106
96
|
$select: string;
|
|
107
|
-
}, ...args: any): Promise<
|
|
108
|
-
/**
|
|
109
|
-
* Get an Object store
|
|
110
|
-
* Get an Object store for the provided UUID. `state` string (State of the Object store) Enum for the state of the Object store. | Enum | Description | | ----------- | ----------- | | `\"OBJECT_STORE_DEPLOYING\"` | 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. | | `\"OBJECT_STORE_OPERATION_ERROR\"` | 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. | | `\"OBJECT_STORE_CREATE_CERT_ERROR\"` | 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. | | `\"OBJECT_STORE_OPERATION_PENDING\"` | 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. | | `\"OBJECT_STORE_INPUT\"` | The Object store is in this state if it has not been deployed. | | `\"OBJECT_STORE_CREATING_CERT\"` | 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. | | `\"OBJECT_STORE_AVAILABLE\"` | 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. | | `\"OBJECT_STORE_DELETE_INPUT_ERROR\"` | An undeployed Object store enters this state if there is an error deleting it. Deleting the Object store can be retried from this state. | | `\"OBJECT_STORE_DELETING_INPUT\"` | 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. | | `\"OBJECT_STORE_DELETE_ERROR\"` | 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. | | `\"OBJECT_STORE_DEPLOYMENT_ERROR\"` | 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. | | `\"OBJECT_STORE_DELETING\"` | 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. |
|
|
111
|
-
* @param { String } extId The UUID of the Object store.
|
|
112
|
-
* @param {Object} opts Optional parameters defined for the operation
|
|
113
|
-
* @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.
|
|
114
|
-
- certificate
|
|
115
|
-
|
|
116
|
-
* @param {Object} args Additional Arguments
|
|
117
|
-
* @return {Promise<ObjectstoreApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ObjectstoreApiResponse } and HTTP response
|
|
118
|
-
*/
|
|
119
|
-
getObjectstore(extId: string, opts: {
|
|
120
|
-
$expand: string;
|
|
121
|
-
}, ...args: any): Promise<ObjectstoreApiResponse>;
|
|
97
|
+
}, ...args: any): Promise<ListCertificatesApiResponse>;
|
|
122
98
|
/**
|
|
123
99
|
* Get a list of the Object stores
|
|
124
100
|
* Get a list of all the Object store details on the registered Prism Central.
|
|
@@ -130,8 +106,8 @@ export class ObjectStoresApi {
|
|
|
130
106
|
* @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>
|
|
131
107
|
* 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>
|
|
132
108
|
* The filter can be applied to the following fields:<br>
|
|
133
|
-
* -
|
|
134
|
-
* -
|
|
109
|
+
* - certificateExtIds<br>
|
|
110
|
+
* - clusterExtId<br>
|
|
135
111
|
* - creationTime<br>
|
|
136
112
|
* - deploymentVersion<br>
|
|
137
113
|
* - description<br>
|
|
@@ -139,9 +115,10 @@ export class ObjectStoresApi {
|
|
|
139
115
|
* - lastUpdateTime<br>
|
|
140
116
|
* - name<br>
|
|
141
117
|
* - numWorkerNodes<br>
|
|
118
|
+
* - publicNetworkIps/ipv4/value<br>
|
|
119
|
+
* - publicNetworkIps/ipv6/value<br>
|
|
142
120
|
* - publicNetworkReference<br>
|
|
143
121
|
* - region<br>
|
|
144
|
-
* - state<br>
|
|
145
122
|
* - storageNetworkDnsIp/ipv4/value<br>
|
|
146
123
|
* - storageNetworkDnsIp/ipv6/value<br>
|
|
147
124
|
* - storageNetworkReference<br>
|
|
@@ -150,8 +127,7 @@ export class ObjectStoresApi {
|
|
|
150
127
|
* - totalCapacityGiB
|
|
151
128
|
* @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>
|
|
152
129
|
* The orderby can be applied to the following fields:<br>
|
|
153
|
-
* -
|
|
154
|
-
* - clusterReference<br>
|
|
130
|
+
* - clusterExtId<br>
|
|
155
131
|
* - creationTime<br>
|
|
156
132
|
* - deploymentVersion<br>
|
|
157
133
|
* - description<br>
|
|
@@ -161,71 +137,63 @@ export class ObjectStoresApi {
|
|
|
161
137
|
* - numWorkerNodes<br>
|
|
162
138
|
* - publicNetworkReference<br>
|
|
163
139
|
* - region<br>
|
|
164
|
-
* - state<br>
|
|
165
|
-
* - storageNetworkDnsIp/ipv4/value<br>
|
|
166
|
-
* - storageNetworkDnsIp/ipv6/value<br>
|
|
167
140
|
* - storageNetworkReference<br>
|
|
168
|
-
* - storageNetworkVip/ipv4/value<br>
|
|
169
|
-
* - storageNetworkVip/ipv6/value<br>
|
|
170
141
|
* - totalCapacityGiB
|
|
171
142
|
* @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.
|
|
172
|
-
-
|
|
143
|
+
- certificates
|
|
173
144
|
|
|
174
145
|
* @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.
|
|
175
|
-
-
|
|
176
|
-
-
|
|
146
|
+
- certificateExtIds
|
|
147
|
+
- clusterExtId
|
|
177
148
|
- creationTime
|
|
178
149
|
- deploymentVersion
|
|
179
150
|
- description
|
|
180
151
|
- domain
|
|
181
|
-
- extId
|
|
182
152
|
- lastUpdateTime
|
|
183
|
-
- links
|
|
184
|
-
- metadata
|
|
185
153
|
- name
|
|
186
154
|
- numWorkerNodes
|
|
187
155
|
- publicNetworkIps
|
|
156
|
+
- publicNetworkIps/ipv4/value
|
|
188
157
|
- publicNetworkReference
|
|
189
158
|
- region
|
|
190
159
|
- state
|
|
191
|
-
- storageNetworkDnsIp
|
|
160
|
+
- storageNetworkDnsIp
|
|
192
161
|
- storageNetworkDnsIp/ipv4/value
|
|
193
|
-
- storageNetworkDnsIp/ipv6/prefixLength
|
|
194
|
-
- storageNetworkDnsIp/ipv6/value
|
|
195
162
|
- storageNetworkReference
|
|
196
|
-
- storageNetworkVip
|
|
163
|
+
- storageNetworkVip
|
|
197
164
|
- storageNetworkVip/ipv4/value
|
|
198
|
-
- storageNetworkVip/ipv6/prefixLength
|
|
199
|
-
- storageNetworkVip/ipv6/value
|
|
200
|
-
- tenantId
|
|
201
165
|
- totalCapacityGiB
|
|
202
166
|
|
|
203
167
|
* @param {Object} args Additional Arguments
|
|
204
|
-
* @return {Promise<
|
|
168
|
+
* @return {Promise<ListObjectstoresApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListObjectstoresApiResponse } and HTTP response
|
|
205
169
|
*/
|
|
206
|
-
|
|
170
|
+
listObjectstores(opts: {
|
|
207
171
|
$page: number;
|
|
208
172
|
$limit: number;
|
|
209
173
|
$filter: string;
|
|
210
174
|
$orderby: string;
|
|
211
175
|
$expand: string;
|
|
212
176
|
$select: string;
|
|
213
|
-
}, ...args: any): Promise<
|
|
177
|
+
}, ...args: any): Promise<ListObjectstoresApiResponse>;
|
|
214
178
|
/**
|
|
215
179
|
* Update an Object store
|
|
216
|
-
* Update an Object store. The deployment of an Object store can be restarted from the state
|
|
217
|
-
* @param { Required<Pick<
|
|
180
|
+
* Update an Object store. The deployment of an Object store can be restarted from the state OBJECT_STORE_DEPLOYMENT_FAILED.
|
|
181
|
+
* @param { Required<Pick<ObjectStore, 'name'>> & Partial<ObjectStore> } body specification
|
|
218
182
|
* @param { String } extId The UUID of the Object store.
|
|
219
183
|
* @param {Object} args Additional Arguments
|
|
220
|
-
* @return {Promise<
|
|
184
|
+
* @return {Promise<UpdateObjectstoreApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateObjectstoreApiResponse } and HTTP response
|
|
221
185
|
*/
|
|
222
|
-
|
|
186
|
+
updateObjectstoreById(extId: string, body: Required<Pick<ObjectStore, 'name'>> & Partial<ObjectStore>, ...args: any): Promise<UpdateObjectstoreApiResponse>;
|
|
223
187
|
#private;
|
|
224
188
|
}
|
|
225
|
-
import
|
|
226
|
-
import
|
|
227
|
-
import
|
|
228
|
-
import
|
|
229
|
-
import
|
|
230
|
-
import
|
|
189
|
+
import CreateCertificateApiResponse from "../models/objects/v4/config/CreateCertificateApiResponse";
|
|
190
|
+
import ObjectStore from "../models/objects/v4/config/ObjectStore";
|
|
191
|
+
import CreateObjectstoreApiResponse from "../models/objects/v4/config/CreateObjectstoreApiResponse";
|
|
192
|
+
import DeleteObjectstoreApiResponse from "../models/objects/v4/config/DeleteObjectstoreApiResponse";
|
|
193
|
+
import GetCaApiResponse from "../models/objects/v4/config/GetCaApiResponse";
|
|
194
|
+
import GetCertificateApiResponse from "../models/objects/v4/config/GetCertificateApiResponse";
|
|
195
|
+
import GetObjectstoreApiResponse from "../models/objects/v4/config/GetObjectstoreApiResponse";
|
|
196
|
+
import ListCertificatesApiResponse from "../models/objects/v4/config/ListCertificatesApiResponse";
|
|
197
|
+
import ListObjectstoresApiResponse from "../models/objects/v4/config/ListObjectstoresApiResponse";
|
|
198
|
+
import UpdateObjectstoreApiResponse from "../models/objects/v4/config/UpdateObjectstoreApiResponse";
|
|
231
199
|
import { ApiClient } from "../ApiClient";
|