kb-cloud-client-typescript 2.3.0-alpha.155 → 2.3.0-alpha.157

package/src/adminapi/apis/environment-api.ts

@@ -70,6 +70,8 @@ import type { EnvironmentUpdate } from '../models';
 // @ts-ignore
 import type { HttpBody } from '../models';
 // @ts-ignore
+import type { KoordinatorReservationSummary } from '../models';
+// @ts-ignore
 import type { Kubeconfig } from '../models';
 // @ts-ignore
 import type { ListKubernetesNodeOpType } from '../models';
@@ -1135,6 +1137,47 @@ export const EnvironmentApiAxiosParamCreator = function (configuration?: Configu
 
 
     
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Get Koordinator Reservation summary for the cluster creation page.
+         * @summary Get Koordinator Reservation summary
+         * @param {string} environmentName name of the environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getKoordinatorReservationSummary: async (environmentName: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'environmentName' is not null or undefined
+            assertParamExists('getKoordinatorReservationSummary', 'environmentName', environmentName)
+            const localVarPath = `/admin/v1/environments/{environmentName}/koordinatorReservations/summary`
+                .replace(`{${"environmentName"}}`, encodeURIComponent(String(environmentName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication BearerToken required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            // authentication DigestAuth required
+            await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
+
+
+    
             setSearchParams(localVarUrlObj, localVarQueryParameter);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
             localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -2548,6 +2591,19 @@ export const EnvironmentApiFp = function(configuration?: Configuration) {
             const localVarOperationServerBasePath = operationServerMap['EnvironmentApi.getEnvironmentStatusHistory']?.[localVarOperationServerIndex]?.url;
             return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
         },
+        /**
+         * Get Koordinator Reservation summary for the cluster creation page.
+         * @summary Get Koordinator Reservation summary
+         * @param {string} environmentName name of the environment
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getKoordinatorReservationSummary(environmentName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<KoordinatorReservationSummary>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getKoordinatorReservationSummary(environmentName, options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['EnvironmentApi.getKoordinatorReservationSummary']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
         /**
          * Get Kubernetes DNS
          * @summary Get Kubernetes DNS
@@ -3112,6 +3168,16 @@ export const EnvironmentApiFactory = function (configuration?: Configuration, ba
         getEnvironmentStatusHistory(requestParameters: EnvironmentApiGetEnvironmentStatusHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<EnvironmentStatusHistory> {
             return localVarFp.getEnvironmentStatusHistory(requestParameters.environmentName, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(axios, basePath));
         },
+        /**
+         * Get Koordinator Reservation summary for the cluster creation page.
+         * @summary Get Koordinator Reservation summary
+         * @param {EnvironmentApiGetKoordinatorReservationSummaryRequest} requestParameters Request parameters.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getKoordinatorReservationSummary(requestParameters: EnvironmentApiGetKoordinatorReservationSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<KoordinatorReservationSummary> {
+            return localVarFp.getKoordinatorReservationSummary(requestParameters.environmentName, options).then((request) => request(axios, basePath));
+        },
         /**
          * Get Kubernetes DNS
          * @summary Get Kubernetes DNS
@@ -3579,6 +3645,16 @@ export interface EnvironmentApiInterface {
      */
     getEnvironmentStatusHistory(requestParameters: EnvironmentApiGetEnvironmentStatusHistoryRequest, options?: RawAxiosRequestConfig): AxiosPromise<EnvironmentStatusHistory>;
 
+    /**
+     * Get Koordinator Reservation summary for the cluster creation page.
+     * @summary Get Koordinator Reservation summary
+     * @param {EnvironmentApiGetKoordinatorReservationSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnvironmentApiInterface
+     */
+    getKoordinatorReservationSummary(requestParameters: EnvironmentApiGetKoordinatorReservationSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<KoordinatorReservationSummary>;
+
     /**
      * Get Kubernetes DNS
      * @summary Get Kubernetes DNS
@@ -4278,6 +4354,20 @@ export interface EnvironmentApiGetEnvironmentStatusHistoryRequest {
     readonly endTime: string
 }
 
+/**
+ * Request parameters for getKoordinatorReservationSummary operation in EnvironmentApi.
+ * @export
+ * @interface EnvironmentApiGetKoordinatorReservationSummaryRequest
+ */
+export interface EnvironmentApiGetKoordinatorReservationSummaryRequest {
+    /**
+     * name of the environment
+     * @type {string}
+     * @memberof EnvironmentApiGetKoordinatorReservationSummary
+     */
+    readonly environmentName: string
+}
+
 /**
  * Request parameters for getKubernetesDNS operation in EnvironmentApi.
  * @export
@@ -5044,6 +5134,18 @@ export class EnvironmentApi extends BaseAPI implements EnvironmentApiInterface {
         return EnvironmentApiFp(this.configuration).getEnvironmentStatusHistory(requestParameters.environmentName, requestParameters.startTime, requestParameters.endTime, options).then((request) => request(this.axios, this.basePath));
     }
 
+    /**
+     * Get Koordinator Reservation summary for the cluster creation page.
+     * @summary Get Koordinator Reservation summary
+     * @param {EnvironmentApiGetKoordinatorReservationSummaryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof EnvironmentApi
+     */
+    public getKoordinatorReservationSummary(requestParameters: EnvironmentApiGetKoordinatorReservationSummaryRequest, options?: RawAxiosRequestConfig) {
+        return EnvironmentApiFp(this.configuration).getKoordinatorReservationSummary(requestParameters.environmentName, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * Get Kubernetes DNS
      * @summary Get Kubernetes DNS

package/src/adminapi/models/cluster-create.ts

@@ -39,6 +39,9 @@ import type { ComponentItemCreate } from './component-item-create';
 import type { InitOptionItem } from './init-option-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -212,6 +215,18 @@ export interface ClusterCreate {
      * @memberof ClusterCreate
      */
     'schedulingPolicy'?: SchedulingPolicyType;
+    /**
+     * Scheduler used by this cluster. If omitted, KBE uses the environment default. When koordinatorEnabled is true for the target environment, the environment default is the globally configured Koordinator scheduler.
+     * @type {string}
+     * @memberof ClusterCreate
+     */
+    'schedulerName'?: string | null;
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof ClusterCreate
+     */
+    'reservationResourceClass'?: KoordinatorReservationResourceClass;
 }
 
 

package/src/adminapi/models/cluster.ts

@@ -39,6 +39,9 @@ import type { ComponentItem } from './component-item';
 import type { InitOptionItem } from './init-option-item';
 // May contain unused imports in some cases
 // @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
 import type { NetworkMode } from './network-mode';
 // May contain unused imports in some cases
 // @ts-ignore
@@ -314,6 +317,18 @@ export interface Cluster {
      * @memberof Cluster
      */
     'schedulingPolicy'?: SchedulingPolicyType;
+    /**
+     * Effective scheduler used when the cluster was created.
+     * @type {string}
+     * @memberof Cluster
+     */
+    'schedulerName'?: string | null;
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof Cluster
+     */
+    'reservationResourceClass'?: KoordinatorReservationResourceClass;
 }
 
 

package/src/adminapi/models/environment-create.ts

@@ -131,6 +131,12 @@ export interface EnvironmentCreate {
      * @memberof EnvironmentCreate
      */
     'sla'?: boolean;
+    /**
+     * Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+     * @type {boolean}
+     * @memberof EnvironmentCreate
+     */
+    'koordinatorEnabled'?: boolean;
 }
 
 

package/src/adminapi/models/environment-update.ts

@@ -152,6 +152,12 @@ export interface EnvironmentUpdate {
      * @memberof EnvironmentUpdate
      */
     'slaEnabled'?: boolean;
+    /**
+     * Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+     * @type {boolean}
+     * @memberof EnvironmentUpdate
+     */
+    'koordinatorEnabled'?: boolean;
     /**
      * 
      * @type {ClusterSchedulingPolicy}

package/src/adminapi/models/environment.ts

@@ -188,6 +188,12 @@ export interface Environment {
      * @memberof Environment
      */
     'slaEnabled'?: boolean;
+    /**
+     * Whether this environment has Koordinator installed and can use Koordinator scheduler and reservations.
+     * @type {boolean}
+     * @memberof Environment
+     */
+    'koordinatorEnabled'?: boolean;
 }
 
 

package/src/adminapi/models/index.ts

@@ -461,6 +461,13 @@ export * from './ip-whitelist';
 export * from './ip-whitelist-list';
 export * from './key';
 export * from './key-list';
+export * from './koordinator-node-reservation';
+export * from './koordinator-reservation-allocate-policy';
+export * from './koordinator-reservation-resource-class';
+export * from './koordinator-reservation-resources';
+export * from './koordinator-reservation-status';
+export * from './koordinator-reservation-summary';
+export * from './koordinator-reservation-summary-item';
 export * from './kubeconfig';
 export * from './license';
 export * from './license-option';
@@ -763,6 +770,7 @@ export * from './role-update';
 export * from './sla';
 export * from './slacluster';
 export * from './slasettings';
+export * from './scheduler-option';
 export * from './scheduling-config';
 export * from './scheduling-policy-type';
 export * from './select-module-mode';
@@ -801,7 +809,6 @@ export * from './storage-class-update';
 export * from './storage-class-volume-binding-mode';
 export * from './storage-config';
 export * from './storage-config-backup';
-export * from './storage-config-log';
 export * from './storage-create';
 export * from './storage-display-name';
 export * from './storage-option';

package/src/adminapi/models/koordinator-node-reservation.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationAllocatePolicy } from './koordinator-reservation-allocate-policy';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResources } from './koordinator-reservation-resources';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationStatus } from './koordinator-reservation-status';
+
+/**
+ * 
+ * @export
+ * @interface KoordinatorNodeReservation
+ */
+export interface KoordinatorNodeReservation {
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof KoordinatorNodeReservation
+     */
+    'resourceClass': KoordinatorReservationResourceClass;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorNodeReservation
+     */
+    'reservationName'?: string;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorNodeReservation
+     */
+    'resources': KoordinatorReservationResources;
+    /**
+     * Kubernetes duration string. Koordinator defaults omitted ttl to 24h.
+     * @type {string}
+     * @memberof KoordinatorNodeReservation
+     */
+    'ttl'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof KoordinatorNodeReservation
+     */
+    'allocateOnce'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof KoordinatorNodeReservation
+     */
+    'preAllocation'?: boolean;
+    /**
+     * 
+     * @type {KoordinatorReservationAllocatePolicy}
+     * @memberof KoordinatorNodeReservation
+     */
+    'allocatePolicy'?: KoordinatorReservationAllocatePolicy;
+    /**
+     * 
+     * @type {KoordinatorReservationStatus}
+     * @memberof KoordinatorNodeReservation
+     */
+    'status'?: KoordinatorReservationStatus;
+}
+
+
+

package/src/adminapi/models/koordinator-reservation-allocate-policy.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @enum {string}
+ */
+
+export const KoordinatorReservationAllocatePolicy = {
+    Restricted: 'Restricted',
+    Aligned: 'Aligned'
+} as const;
+
+export type KoordinatorReservationAllocatePolicy = typeof KoordinatorReservationAllocatePolicy[keyof typeof KoordinatorReservationAllocatePolicy];
+
+
+

package/src/adminapi/models/{storage-config-log.ts → koordinator-reservation-resource-class.ts}

@@ -15,16 +15,17 @@
 
 
 /**
- * the storage config for log
+ * 
  * @export
- * @interface StorageConfigLog
+ * @enum {string}
  */
-export interface StorageConfigLog {
-    /**
-     * the name of storage
-     * @type {string}
-     * @memberof StorageConfigLog
-     */
-    'storageName': string;
-}
+
+export const KoordinatorReservationResourceClass = {
+    database: 'database',
+    business: 'business'
+} as const;
+
+export type KoordinatorReservationResourceClass = typeof KoordinatorReservationResourceClass[keyof typeof KoordinatorReservationResourceClass];
+
+
 

package/src/adminapi/models/koordinator-reservation-resources.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Resource requests supported by KBE for Koordinator Reservations. Values are Kubernetes quantities and responses use Kubernetes canonical quantity strings.
+ * @export
+ * @interface KoordinatorReservationResources
+ */
+export interface KoordinatorReservationResources {
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationResources
+     */
+    'cpu'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationResources
+     */
+    'memory'?: string;
+}
+

package/src/adminapi/models/koordinator-reservation-status.ts

@@ -0,0 +1,57 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResources } from './koordinator-reservation-resources';
+
+/**
+ * 
+ * @export
+ * @interface KoordinatorReservationStatus
+ */
+export interface KoordinatorReservationStatus {
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationStatus
+     */
+    'phase'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationStatus
+     */
+    'nodeName'?: string;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorReservationStatus
+     */
+    'allocatable'?: KoordinatorReservationResources;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorReservationStatus
+     */
+    'allocated'?: KoordinatorReservationResources;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorReservationStatus
+     */
+    'available'?: KoordinatorReservationResources;
+}
+

package/src/adminapi/models/koordinator-reservation-summary-item.ts

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResourceClass } from './koordinator-reservation-resource-class';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationResources } from './koordinator-reservation-resources';
+
+/**
+ * 
+ * @export
+ * @interface KoordinatorReservationSummaryItem
+ */
+export interface KoordinatorReservationSummaryItem {
+    /**
+     * 
+     * @type {KoordinatorReservationResourceClass}
+     * @memberof KoordinatorReservationSummaryItem
+     */
+    'resourceClass'?: KoordinatorReservationResourceClass;
+    /**
+     * 
+     * @type {number}
+     * @memberof KoordinatorReservationSummaryItem
+     */
+    'nodeCount'?: number;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorReservationSummaryItem
+     */
+    'total'?: KoordinatorReservationResources;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorReservationSummaryItem
+     */
+    'allocated'?: KoordinatorReservationResources;
+    /**
+     * 
+     * @type {KoordinatorReservationResources}
+     * @memberof KoordinatorReservationSummaryItem
+     */
+    'available'?: KoordinatorReservationResources;
+}
+
+
+

package/src/adminapi/models/koordinator-reservation-summary.ts

@@ -0,0 +1,60 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorReservationSummaryItem } from './koordinator-reservation-summary-item';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { SchedulerOption } from './scheduler-option';
+
+/**
+ * 
+ * @export
+ * @interface KoordinatorReservationSummary
+ */
+export interface KoordinatorReservationSummary {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof KoordinatorReservationSummary
+     */
+    'enabled': boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationSummary
+     */
+    'schedulerName'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof KoordinatorReservationSummary
+     */
+    'defaultSchedulerName'?: string;
+    /**
+     * 
+     * @type {Array<SchedulerOption>}
+     * @memberof KoordinatorReservationSummary
+     */
+    'schedulerOptions': Array<SchedulerOption>;
+    /**
+     * 
+     * @type {Array<KoordinatorReservationSummaryItem>}
+     * @memberof KoordinatorReservationSummary
+     */
+    'items': Array<KoordinatorReservationSummaryItem>;
+}
+

package/src/adminapi/models/node.ts

@@ -13,6 +13,9 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { KoordinatorNodeReservation } from './koordinator-node-reservation';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { NodeStatus } from './node-status';
@@ -110,6 +113,12 @@ export interface Node {
      * @memberof Node
      */
     'managed'?: boolean;
+    /**
+     * 
+     * @type {Array<KoordinatorNodeReservation>}
+     * @memberof Node
+     */
+    'koordinatorReservations'?: Array<KoordinatorNodeReservation>;
     /**
      * 
      * @type {NodeStatus}

package/src/adminapi/models/parameter-prop.ts

@@ -80,5 +80,11 @@ export interface ParameterProp {
      * @memberof ParameterProp
      */
     'enum'?: Array<any>;
+    /**
+     * The unit of the parameter value (e.g., seconds, bytes, ms, percentage)
+     * @type {string}
+     * @memberof ParameterProp
+     */
+    'unit'?: string;
 }