kb-cloud-client-typescript 2.4.0-alpha.12 → 2.4.0-alpha.121

package/src/adminapi/models/object-privilege-snapshot.ts

@@ -0,0 +1,105 @@
+/* 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 { ObjectPrivilegeEvidence } from './object-privilege-evidence';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeGrant } from './object-privilege-grant';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegePrerequisiteCheck } from './object-privilege-prerequisite-check';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeSubject } from './object-privilege-subject';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeTarget } from './object-privilege-target';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeSnapshot
+ */
+export interface ObjectPrivilegeSnapshot {
+    /**
+     * 
+     * @type {ObjectPrivilegeTarget}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'target': ObjectPrivilegeTarget;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'supportedPrivileges': Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'supportedColumnPrivileges': Array<string>;
+    /**
+     * Native grants to this account at this exact object scope. Does not include inherited grants or prove executable access.
+     * @type {Array<ObjectPrivilegeGrant>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'directPrivileges': Array<ObjectPrivilegeGrant>;
+    /**
+     * Native PostgreSQL checks when available. False for PostgreSQL large objects before 18 and MySQL (active roles depend on the session). False or omitted effectivePrivileges never means no access.
+     * @type {boolean}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'effectivePrivilegesKnown': boolean;
+    /**
+     * PostgreSQL native has_*_privilege checks, including PUBLIC and inherited permissions. Other prerequisites, RLS and session SET ROLE can affect actual execution.
+     * @type {Array<ObjectPrivilegeGrant>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'effectivePrivileges'?: Array<ObjectPrivilegeGrant>;
+    /**
+     * Native behavior and scope overlap explanations, including preset overlap and partial revokes.
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'warnings'?: Array<string>;
+    /**
+     * 
+     * @type {ObjectPrivilegeSubject}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'subject': ObjectPrivilegeSubject;
+    /**
+     * Versioned namespaced JSON extensions. Response keys unknown to a client may be ignored. Change keys must be registered and strictly decoded by the current engine; PG/MySQL currently accept no change extensions.
+     * @type {{ [key: string]: any; }}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'extensions'?: { [key: string]: any; };
+    /**
+     * 
+     * @type {Array<ObjectPrivilegePrerequisiteCheck>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'prerequisiteChecks'?: Array<ObjectPrivilegePrerequisiteCheck>;
+    /**
+     * 
+     * @type {Array<ObjectPrivilegeEvidence>}
+     * @memberof ObjectPrivilegeSnapshot
+     */
+    'evidence'?: Array<ObjectPrivilegeEvidence>;
+}
+

package/src/adminapi/models/object-privilege-spec.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeSpec
+ */
+export interface ObjectPrivilegeSpec {
+    /**
+     * Native keyword from the capability for the requested object type.
+     * @type {string}
+     * @memberof ObjectPrivilegeSpec
+     */
+    'name': string;
+    /**
+     * Exact columns, supported only on table/view objects. Empty means object-level privileges.
+     * @type {Set<string>}
+     * @memberof ObjectPrivilegeSpec
+     */
+    'columns'?: Set<string>;
+}
+

package/src/adminapi/models/object-privilege-subject-type.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.
+ */
+
+
+
+/**
+ * Native authorization subject kind. Does not create accounts or roles, or change memberships.
+ * @export
+ * @enum {string}
+ */
+
+export const ObjectPrivilegeSubjectType = {
+    account: 'account',
+    role: 'role'
+} as const;
+
+export type ObjectPrivilegeSubjectType = typeof ObjectPrivilegeSubjectType[keyof typeof ObjectPrivilegeSubjectType];
+
+
+

package/src/adminapi/models/object-privilege-subject.ts

@@ -0,0 +1,47 @@
+/* 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 { ObjectPrivilegeSubjectType } from './object-privilege-subject-type';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeSubject
+ */
+export interface ObjectPrivilegeSubject {
+    /**
+     * Exact native database account or role name.
+     * @type {string}
+     * @memberof ObjectPrivilegeSubject
+     */
+    'name': string;
+    /**
+     * 
+     * @type {ObjectPrivilegeSubjectType}
+     * @memberof ObjectPrivilegeSubject
+     */
+    'type': ObjectPrivilegeSubjectType;
+    /**
+     * Engine-declared native identity qualifiers. MySQL host defaults to %. Unknown keys are rejected, including empty values.
+     * @type {{ [key: string]: string; }}
+     * @memberof ObjectPrivilegeSubject
+     */
+    'qualifiers'?: { [key: string]: string; };
+}
+
+
+

package/src/adminapi/models/object-privilege-target.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.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeTarget
+ */
+export interface ObjectPrivilegeTarget {
+    /**
+     * Native object kind returned by capabilities. Table includes views; view/foreignTable/materializedView also validate the concrete kind.
+     * @type {string}
+     * @memberof ObjectPrivilegeTarget
+     */
+    'objectType': string;
+    /**
+     * Database name used to locate the resource. PostgreSQL also uses this as the connection database, including cluster-wide objects.
+     * @type {string}
+     * @memberof ObjectPrivilegeTarget
+     */
+    'databaseName'?: string;
+    /**
+     * Native schema containing the object, or the schema itself for schema objects.
+     * @type {string}
+     * @memberof ObjectPrivilegeTarget
+     */
+    'schemaName'?: string;
+    /**
+     * Exact object name, never a SQL fragment. Required except for global, database, schema, and largeObject.
+     * @type {string}
+     * @memberof ObjectPrivilegeTarget
+     */
+    'objectName'?: string;
+    /**
+     * Opaque native identity returned by discovery. Interpretation and validation belong to the engine. PostgreSQL routines and large objects require a nonzero uint32 OID; routine names must also match.
+     * @type {string}
+     * @memberof ObjectPrivilegeTarget
+     */
+    'objectId'?: string;
+    /**
+     * Native catalog name when required by engine capabilities. Unsupported fields are rejected.
+     * @type {string}
+     * @memberof ObjectPrivilegeTarget
+     */
+    'catalogName'?: string;
+}
+

package/src/adminapi/models/object-type-enum.ts

@@ -0,0 +1,32 @@
+/* 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 ObjectTypeEnum = {
+    cluster: 'cluster',
+    channel: 'channel',
+    unknown: 'unknown'
+} as const;
+
+export type ObjectTypeEnum = typeof ObjectTypeEnum[keyof typeof ObjectTypeEnum];
+
+
+

package/src/adminapi/models/ops-expose-type.ts

@@ -15,14 +15,15 @@
 
 
 /**
- * Specifies the type of exposure for the KubeBlocks cluster.
+ * Specifies the type of exposure for the KubeBlocks cluster. Internal exposure creates an internal-ro ClusterIP service and requires readonly=true; it is independent of vpc and internet exposure.
  * @export
  * @enum {string}
  */
 
 export const OpsExposeType = {
     vpc: 'vpc',
-    internet: 'internet'
+    internet: 'internet',
+    internal: 'internal'
 } as const;
 
 export type OpsExposeType = typeof OpsExposeType[keyof typeof OpsExposeType];

package/src/adminapi/models/ops-expose.ts

@@ -42,7 +42,7 @@ export interface OpsExpose {
      */
     'enable': boolean;
     /**
-     * 
+     * Select the configured read-only role. Must be true for internal exposure.
      * @type {boolean}
      * @memberof OpsExpose
      */
@@ -66,13 +66,13 @@ export interface OpsExpose {
      */
     'portsMapping'?: Array<OpsExposePortsMappingInner>;
     /**
-     * The IP address of the LoadBalancer service. If not set, the IP address will be assigned by the system. Only available when vpcServiceType is LoadBalancer.
+     * The requested IPv4 or IPv6 address of the LoadBalancer service. If not set, IP addresses will be assigned by the system. For dual-stack MetalLB services, the system allocates the missing address family from the same VIP pool. Only available when vpcServiceType is LoadBalancer.
      * @type {string}
      * @memberof OpsExpose
      */
     'loadBalancerIP'?: string | null;
     /**
-     * The IP pool ID of the LoadBalancer service. If not set, the IP pool will be assigned by the system. Only available when vpcServiceType is LoadBalancer.
+     * The IP pool ID of the LoadBalancer service. If not set, the IP pool will be assigned by the system. All VIPs of a dual-stack MetalLB service are allocated from the same pool. Only available when vpcServiceType is LoadBalancer.
      * @type {string}
      * @memberof OpsExpose
      */

package/src/adminapi/models/ops-hscale.ts

@@ -13,12 +13,15 @@
  */
 
 
+// May contain unused imports in some cases
+// @ts-ignore
+import type { InstanceTemplateReplicas } from './instance-template-replicas';
 // May contain unused imports in some cases
 // @ts-ignore
 import type { TaskSchedule } from './task-schedule';
 
 /**
- * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. It requires specifying either the number of replicas or the number of shards.
+ * OpsHScale is the payload to horizontally scale a KubeBlocks cluster. Specify replicas or shards. Replica scaling requires explicit template targets when the current mode component declares instanceTemplate.ops hscale.
  * @export
  * @interface OpsHScale
  */
@@ -41,6 +44,12 @@ export interface OpsHScale {
      * @memberof OpsHScale
      */
     'replicas'?: number | null;
+    /**
+     * Explicit template replica targets, required when the current mode component instanceTemplate.ops includes hscale. Otherwise omit for component-level scaling. Requires top-level replicas and every name from instanceTemplate.names, without missing, extra, or duplicate names. Template replica counts must sum to the component target; equal distribution is not required by the API. Component and template changes are sent together in one OpsRequest using current Cluster replicas to calculate scaleIn/scaleOut deltas. Shard-count scaling cannot include this list.
+     * @type {Array<InstanceTemplateReplicas>}
+     * @memberof OpsHScale
+     */
+    'instanceTemplates'?: Array<InstanceTemplateReplicas>;
     /**
      * List of online instance names to be switched to offline during scaling in.
      * @type {Array<string>}

package/src/adminapi/models/ops-request-name.ts

@@ -26,12 +26,6 @@ export interface OpsRequestName {
      * @memberof OpsRequestName
      */
     'opsRequestName'?: string;
-    /**
-     * 
-     * @type {string}
-     * @memberof OpsRequestName
-     */
-    'clusterTaskId'?: string;
     /**
      * 
      * @type {string}

package/src/adminapi/models/{ops-volume-expand-volumes-inner.ts → ops-volume-expand-volumes-items0.ts}

@@ -17,19 +17,19 @@
 /**
  * 
  * @export
- * @interface OpsVolumeExpandVolumesInner
+ * @interface OpsVolumeExpandVolumesItems0
  */
-export interface OpsVolumeExpandVolumesInner {
+export interface OpsVolumeExpandVolumesItems0 {
     /**
-     * volume name
+     * Volume name.
      * @type {string}
-     * @memberof OpsVolumeExpandVolumesInner
+     * @memberof OpsVolumeExpandVolumesItems0
      */
     'name': string;
     /**
-     * Storage size, the unit is Gi.
+     * Desired size with Gi suffix, for example 30Gi.
      * @type {string}
-     * @memberof OpsVolumeExpandVolumesInner
+     * @memberof OpsVolumeExpandVolumesItems0
      */
     'storage': string;
 }

package/src/adminapi/models/ops-volume-expand.ts

@@ -15,14 +15,23 @@
 
 // May contain unused imports in some cases
 // @ts-ignore
-import type { OpsVolumeExpandVolumesInner } from './ops-volume-expand-volumes-inner';
+import type { InstanceTemplateVolumeExpand } from './instance-template-volume-expand';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OpsVolumeExpandVolumesItems0 } from './ops-volume-expand-volumes-items0';
 
 /**
- * OpsVolumeExpand is the payload to expand volume for a KubeBlocks cluster
+ * Expand component volumes and explicit targets for components with template expansion enabled.
  * @export
  * @interface OpsVolumeExpand
  */
 export interface OpsVolumeExpand {
+    /**
+     * Required when the current mode component instanceTemplate.ops includes storageExpansion; otherwise omit for component-level expansion. Explicit targets require this capability. Every configured template must explicitly specify the same volume names and target capacities as component-level volumes. Names identify templates, not Pods. Targets are forwarded together in one OpsRequest without filling in, merging, or removing template targets. KubeBlocks may materialize template volumeClaimTemplates for explicitly targeted inherited volumes.
+     * @type {Array<InstanceTemplateVolumeExpand>}
+     * @memberof OpsVolumeExpand
+     */
+    'instanceTemplates'?: Array<InstanceTemplateVolumeExpand>;
     /**
      * 
      * @type {string}
@@ -31,9 +40,9 @@ export interface OpsVolumeExpand {
     'component': string;
     /**
      * 
-     * @type {Array<OpsVolumeExpandVolumesInner>}
+     * @type {Array<OpsVolumeExpandVolumesItems0>}
      * @memberof OpsVolumeExpand
      */
-    'volumes': Array<OpsVolumeExpandVolumesInner>;
+    'volumes': Array<OpsVolumeExpandVolumesItems0>;
 }
 

package/src/adminapi/models/ops-vscale.ts

@@ -42,7 +42,7 @@ export interface OpsVScale {
      */
     'memory'?: string;
     /**
-     * class code of the cluster
+     * Class code for component-level vertical scaling.
      * @type {string}
      * @memberof OpsVScale
      */

package/src/adminapi/models/oracle-tablespace-contents.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.
+ */
+
+
+
+/**
+ * New tablespaces default to PERMANENT when omitted.
+ * @export
+ * @enum {string}
+ */
+
+export const OracleTablespaceContents = {
+    PERMANENT: 'PERMANENT',
+    TEMPORARY: 'TEMPORARY'
+} as const;
+
+export type OracleTablespaceContents = typeof OracleTablespaceContents[keyof typeof OracleTablespaceContents];
+
+
+

package/src/adminapi/models/oracle-tablespace-create.ts

@@ -0,0 +1,56 @@
+/* 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 { OracleTablespaceContents } from './oracle-tablespace-contents';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OracleTablespaceFileSpec } from './oracle-tablespace-file-spec';
+
+/**
+ * 
+ * @export
+ * @interface OracleTablespaceCreate
+ */
+export interface OracleTablespaceCreate {
+    /**
+     * Converted to uppercase. Limited to 30 ASCII bytes for compatibility with Oracle 12.1.
+     * @type {string}
+     * @memberof OracleTablespaceCreate
+     */
+    'name': string;
+    /**
+     * 
+     * @type {OracleTablespaceContents}
+     * @memberof OracleTablespaceCreate
+     */
+    'contents'?: OracleTablespaceContents;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof OracleTablespaceCreate
+     */
+    'bigfile'?: boolean;
+    /**
+     * Exactly one file for BIGFILE tablespaces.
+     * @type {Array<OracleTablespaceFileSpec>}
+     * @memberof OracleTablespaceCreate
+     */
+    'files': Array<OracleTablespaceFileSpec>;
+}
+
+
+

package/src/adminapi/models/oracle-tablespace-expand-action.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 OracleTablespaceExpandAction = {
+    resize: 'resize',
+    addFile: 'addFile'
+} as const;
+
+export type OracleTablespaceExpandAction = typeof OracleTablespaceExpandAction[keyof typeof OracleTablespaceExpandAction];
+
+
+

package/src/adminapi/models/oracle-tablespace-expand.ts

@@ -0,0 +1,56 @@
+/* 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 { OracleTablespaceExpandAction } from './oracle-tablespace-expand-action';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { OracleTablespaceFileSpec } from './oracle-tablespace-file-spec';
+
+/**
+ * One DDL operation per request. Use resize with fileId and sizeMB, or addFile with file. Shrinking and adding files to BIGFILE tablespaces are rejected.
+ * @export
+ * @interface OracleTablespaceExpand
+ */
+export interface OracleTablespaceExpand {
+    /**
+     * 
+     * @type {OracleTablespaceExpandAction}
+     * @memberof OracleTablespaceExpand
+     */
+    'action': OracleTablespaceExpandAction;
+    /**
+     * 
+     * @type {number}
+     * @memberof OracleTablespaceExpand
+     */
+    'fileId'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof OracleTablespaceExpand
+     */
+    'sizeMB'?: number;
+    /**
+     * 
+     * @type {OracleTablespaceFileSpec}
+     * @memberof OracleTablespaceExpand
+     */
+    'file'?: OracleTablespaceFileSpec;
+}
+
+
+