web-console/src/druid-models/async-query/async-query.ts

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { ErrorResponse } from '../../utils';
import type { Counters, StageDefinition } from '../stages/stages';
import type { MsqTaskErrorReport } from '../task/task';

export type AsyncState = 'ACCEPTED' | 'RUNNING' | 'SUCCESS' | 'FAILED';

export interface AsyncStatusResponse {
  queryId: string;
  state: AsyncState;
  createdAt: string;
  durationMs: number;
  schema?: { name: string; type: string; nativeType: string }[];
  result?: {
    dataSource: string;
    sampleRecords?: any[][];
    numTotalRows: number;
    totalSizeInBytes: number;
    pages?: {
      id: number;
      numRows: number;
      sizeInBytes: number;
    }[];
  };
  stages?: StageDefinition[];
  counters?: Counters;
  errorDetails?: ErrorResponse;
  warnings?: MsqTaskErrorReport[];
}