@gooddata/api-client-tiger 11.30.0-alpha.4 → 11.30.0

package/esm/generated/afm-rest-api/api.d.ts

@@ -32,6 +32,10 @@ export interface AFM {
      * Metrics to be referenced from other AFM objects (e.g. filters) but not included in the result.
      */
     'auxMeasures'?: Array<MeasureItem>;
+    /**
+     * (EXPERIMENTAL) Parameter values to use for this execution.
+     */
+    'parameters'?: Array<ParameterItem>;
     /**
      * (EXPERIMENTAL) Override definitions of catalog metrics for this request. Allows substituting a catalog metric\'s MAQL definition without modifying the stored definition.
      */
@@ -158,6 +162,17 @@ export interface AfmObjectIdentifierLabelIdentifier {
     'id': string;
 }
 export type AfmObjectIdentifierLabelIdentifierTypeEnum = 'label';
+/**
+ * Reference to the parameter.
+ */
+export interface AfmObjectIdentifierParameter {
+    'identifier': AfmObjectIdentifierParameterIdentifier;
+}
+export interface AfmObjectIdentifierParameterIdentifier {
+    'id': string;
+    'type': AfmObjectIdentifierParameterIdentifierTypeEnum;
+}
+export type AfmObjectIdentifierParameterIdentifierTypeEnum = 'parameter';
 /**
  * Entity describing the valid descendants request.
  */
@@ -288,6 +303,15 @@ export interface AnalyticsCatalogUser {
      */
     'lastname': string;
 }
+/**
+ * Request to run ANALYZE TABLE for tables in a database instance
+ */
+export interface AnalyzeStatisticsRequest {
+    /**
+     * Table names to analyze. If empty or null, all tables in the database are analyzed.
+     */
+    'tableNames'?: Array<string>;
+}
 /**
  * Anomaly detection configuration.
  */
@@ -904,6 +928,12 @@ export interface CreatePipeTableRequest {
     'columnOverrides'?: {
         [key: string]: string;
     };
+    /**
+     * Maps non-key column names to their StarRocks aggregation function (SUM, MIN, MAX, REPLACE, REPLACE_IF_NOT_NULL, HLL_UNION, BITMAP_UNION, PERCENTILE_UNION). Required for every non-key column when keyConfig type is \'aggregate\'. Ignored for other key types.
+     */
+    'aggregationOverrides'?: {
+        [key: string]: string;
+    };
     /**
      * How often (in seconds) the pipe polls for new files. 0 or null = use server default.
      */
@@ -1965,12 +1995,12 @@ export interface Operation {
      */
     'id': string;
     /**
-     * Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table.
+     * Type of the long-running operation. * `provision-database` — Provisioning of an AI Lake database. * `deprovision-database` — Deprovisioning (deletion) of an AI Lake database. * `run-service-command` — Running a command in a particular AI Lake service. * `create-pipe-table` — Creating a pipe table backed by an S3 data source. * `delete-pipe-table` — Deleting a pipe table. * `analyze-statistics` — Running ANALYZE TABLE for CBO statistics collection.
      */
     'kind': OperationKindEnum;
     'status': string;
 }
-export type OperationKindEnum = 'provision-database' | 'deprovision-database' | 'run-service-command' | 'create-pipe-table' | 'delete-pipe-table';
+export type OperationKindEnum = 'provision-database' | 'deprovision-database' | 'run-service-command' | 'create-pipe-table' | 'delete-pipe-table' | 'analyze-statistics';
 /**
  * Error information for a failed operation
  */
@@ -2053,6 +2083,16 @@ export interface Paging {
      */
     'next'?: string;
 }
+/**
+ * (EXPERIMENTAL) Parameter value for this execution.
+ */
+export interface ParameterItem {
+    'parameter': AfmObjectIdentifierParameter;
+    /**
+     * Value to use for this parameter instead of its default.
+     */
+    'value': string;
+}
 /**
  * Partition configuration for the table.
  */
@@ -3232,6 +3272,17 @@ export interface WorkflowStatusResponseDto {
     'error'?: string;
     'currentPhase'?: string;
 }
+/**
+ * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+ * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+ * @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
+ * @param {AnalyzeStatisticsRequest} analyzeStatisticsRequest
+ * @param {string} [operationId]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function AILakeApiAxiosParamCreator_AnalyzeStatistics(instanceId: string, analyzeStatisticsRequest: AnalyzeStatisticsRequest, operationId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
  * @summary (BETA) Create a new AI Lake pipe table
@@ -3354,6 +3405,17 @@ export declare function AILakeApiAxiosParamCreator_ProvisionAiLakeDatabaseInstan
  * @throws {RequiredError}
  */
 export declare function AILakeApiAxiosParamCreator_RunAiLakeServiceCommand(serviceId: string, commandName: string, runServiceCommandRequest: RunServiceCommandRequest, operationId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+ * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {AILakeApiAnalyzeStatisticsRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function AILakeApi_AnalyzeStatistics(axios: AxiosInstance, basePath: string, requestParameters: AILakeApiAnalyzeStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<object>;
 /**
  * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
  * @summary (BETA) Create a new AI Lake pipe table
@@ -3492,6 +3554,15 @@ export declare function AILakeApi_RunAiLakeServiceCommand(axios: AxiosInstance,
  * @interface AILakeApi
  */
 export interface AILakeApiInterface {
+    /**
+     * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+     * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+     * @param {AILakeApiAnalyzeStatisticsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AILakeApiInterface
+     */
+    analyzeStatistics(requestParameters: AILakeApiAnalyzeStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
     /**
      * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
      * @summary (BETA) Create a new AI Lake pipe table
@@ -3601,6 +3672,31 @@ export interface AILakeApiInterface {
      */
     runAiLakeServiceCommand(requestParameters: AILakeApiRunAiLakeServiceCommandRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
 }
+/**
+ * Request parameters for analyzeStatistics operation in AILakeApi.
+ * @export
+ * @interface AILakeApiAnalyzeStatisticsRequest
+ */
+export interface AILakeApiAnalyzeStatisticsRequest {
+    /**
+     * Database instance identifier. Accepts the database name (preferred) or UUID.
+     * @type {string}
+     * @memberof AILakeApiAnalyzeStatistics
+     */
+    readonly instanceId: string;
+    /**
+     *
+     * @type {AnalyzeStatisticsRequest}
+     * @memberof AILakeApiAnalyzeStatistics
+     */
+    readonly analyzeStatisticsRequest: AnalyzeStatisticsRequest;
+    /**
+     *
+     * @type {string}
+     * @memberof AILakeApiAnalyzeStatistics
+     */
+    readonly operationId?: string;
+}
 /**
  * Request parameters for createAiLakePipeTable operation in AILakeApi.
  * @export
@@ -3848,6 +3944,15 @@ export interface AILakeApiRunAiLakeServiceCommandRequest {
  * @extends {BaseAPI}
  */
 export declare class AILakeApi extends BaseAPI implements AILakeApiInterface {
+    /**
+     * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+     * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+     * @param {AILakeApiAnalyzeStatisticsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AILakeApi
+     */
+    analyzeStatistics(requestParameters: AILakeApiAnalyzeStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
     /**
      * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
      * @summary (BETA) Create a new AI Lake pipe table
@@ -4204,6 +4309,17 @@ export declare class AILakeDatabasesApi extends BaseAPI implements AILakeDatabas
      */
     provisionAiLakeDatabaseInstance(requestParameters: AILakeDatabasesApiProvisionAiLakeDatabaseInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
 }
+/**
+ * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+ * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+ * @param {string} instanceId Database instance identifier. Accepts the database name (preferred) or UUID.
+ * @param {AnalyzeStatisticsRequest} analyzeStatisticsRequest
+ * @param {string} [operationId]
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function AILakePipeTablesApiAxiosParamCreator_AnalyzeStatistics(instanceId: string, analyzeStatisticsRequest: AnalyzeStatisticsRequest, operationId?: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
  * @summary (BETA) Create a new AI Lake pipe table
@@ -4245,6 +4361,17 @@ export declare function AILakePipeTablesApiAxiosParamCreator_GetAiLakePipeTable(
  * @throws {RequiredError}
  */
 export declare function AILakePipeTablesApiAxiosParamCreator_ListAiLakePipeTables(instanceId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+ * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {AILakePipeTablesApiAnalyzeStatisticsRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function AILakePipeTablesApi_AnalyzeStatistics(axios: AxiosInstance, basePath: string, requestParameters: AILakePipeTablesApiAnalyzeStatisticsRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<object>;
 /**
  * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
  * @summary (BETA) Create a new AI Lake pipe table
@@ -4295,6 +4422,15 @@ export declare function AILakePipeTablesApi_ListAiLakePipeTables(axios: AxiosIns
  * @interface AILakePipeTablesApi
  */
 export interface AILakePipeTablesApiInterface {
+    /**
+     * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+     * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+     * @param {AILakePipeTablesApiAnalyzeStatisticsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AILakePipeTablesApiInterface
+     */
+    analyzeStatistics(requestParameters: AILakePipeTablesApiAnalyzeStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
     /**
      * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
      * @summary (BETA) Create a new AI Lake pipe table
@@ -4332,6 +4468,31 @@ export interface AILakePipeTablesApiInterface {
      */
     listAiLakePipeTables(requestParameters: AILakePipeTablesApiListAiLakePipeTablesRequest, options?: AxiosRequestConfig): AxiosPromise<ListPipeTablesResponse>;
 }
+/**
+ * Request parameters for analyzeStatistics operation in AILakePipeTablesApi.
+ * @export
+ * @interface AILakePipeTablesApiAnalyzeStatisticsRequest
+ */
+export interface AILakePipeTablesApiAnalyzeStatisticsRequest {
+    /**
+     * Database instance identifier. Accepts the database name (preferred) or UUID.
+     * @type {string}
+     * @memberof AILakePipeTablesApiAnalyzeStatistics
+     */
+    readonly instanceId: string;
+    /**
+     *
+     * @type {AnalyzeStatisticsRequest}
+     * @memberof AILakePipeTablesApiAnalyzeStatistics
+     */
+    readonly analyzeStatisticsRequest: AnalyzeStatisticsRequest;
+    /**
+     *
+     * @type {string}
+     * @memberof AILakePipeTablesApiAnalyzeStatistics
+     */
+    readonly operationId?: string;
+}
 /**
  * Request parameters for createAiLakePipeTable operation in AILakePipeTablesApi.
  * @export
@@ -4421,6 +4582,15 @@ export interface AILakePipeTablesApiListAiLakePipeTablesRequest {
  * @extends {BaseAPI}
  */
 export declare class AILakePipeTablesApi extends BaseAPI implements AILakePipeTablesApiInterface {
+    /**
+     * (BETA) Collects CBO statistics for tables in a StarRocks database. Works for both internal (native/PIPE) and external (Iceberg) catalogs. If tableNames is empty, all tables are analyzed.
+     * @summary (BETA) Run ANALYZE TABLE for tables in a database instance
+     * @param {AILakePipeTablesApiAnalyzeStatisticsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AILakePipeTablesApi
+     */
+    analyzeStatistics(requestParameters: AILakePipeTablesApiAnalyzeStatisticsRequest, options?: AxiosRequestConfig): AxiosPromise<object>;
     /**
      * (BETA) Creates a pipe-backed OLAP table in the given AI Lake database instance. Infers schema from parquet files. Returns an operation-id header the client can use to poll for progress.
      * @summary (BETA) Create a new AI Lake pipe table