@rockset/client/dist/codegen/api.d.ts

Client for querying Rockset and interacting with the Rockset API.

/**
 * REST API
 * Rockset's REST API allows for creating and managing all resources in Rockset. Each supported endpoint is documented below.  All requests must be authorized with a Rockset API key, which can be created in the [Rockset console](https://console.rockset.com). The API key must be provided as `ApiKey <api_key>` in the `Authorization` request header. For example: ``` Authorization: ApiKey aB35kDjg93J5nsf4GjwMeErAVd832F7ad4vhsW1S02kfZiab42sTsfW5Sxt25asT ```  All endpoints are only accessible via https.  Build something awesome!
 *
 * OpenAPI spec version: v1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
import { Configuration } from "./configuration";
/**
 *
 * @export
 */
export declare const COLLECTION_FORMATS: {
    csv: string;
    ssv: string;
    tsv: string;
    pipes: string;
};
/**
 *
 * @export
 * @interface FetchAPI
 */
export interface FetchAPI {
    (url: string, init?: any): Promise<Response>;
}
/**
 *
 * @export
 * @interface FetchArgs
 */
export interface FetchArgs {
    url: string;
    options: any;
}
/**
 *
 * @export
 * @class BaseAPI
 */
export declare class BaseAPI {
    protected basePath: string;
    protected fetch: FetchAPI;
    protected configuration: Configuration;
    constructor(configuration?: Configuration, basePath?: string, fetch?: FetchAPI);
}
/**
 *
 * @export
 * @class RequiredError
 * @extends {Error}
 */
export declare class RequiredError extends Error {
    field: string;
    name: "RequiredError";
    constructor(field: string, msg?: string);
}
/**
 *
 * @export
 * @interface AddDocumentsRequest
 */
export interface AddDocumentsRequest {
    /**
     * Array of documents to be added to the collection.
     * @type {Array<any>}
     * @memberof AddDocumentsRequest
     */
    data: Array<any>;
}
/**
 *
 * @export
 * @interface AddDocumentsResponse
 */
export interface AddDocumentsResponse {
    /**
     * Information about the added documents.
     * @type {Array<DocumentStatus>}
     * @memberof AddDocumentsResponse
     */
    data?: Array<DocumentStatus>;
    /**
     * A string representing the collection offset after completing the write.
     * @type {string}
     * @memberof AddDocumentsResponse
     */
    last_offset?: string;
}
/**
 *
 * @export
 * @interface Alias
 */
export interface Alias {
    /**
     * List of fully qualified collection names referenced by alias.
     * @type {Array<string>}
     * @memberof Alias
     */
    collections?: Array<string>;
    /**
     * ISO-8601 date.
     * @type {string}
     * @memberof Alias
     */
    created_at?: string;
    /**
     * Name of the API key that was used to create this object if one was used.
     * @type {string}
     * @memberof Alias
     */
    created_by_apikey_name?: string;
    /**
     * Email of the creator.
     * @type {string}
     * @memberof Alias
     */
    creator_email?: string;
    /**
     * Alias description.
     * @type {string}
     * @memberof Alias
     */
    description?: string;
    /**
     * ISO-8601 date.
     * @type {string}
     * @memberof Alias
     */
    modified_at?: string;
    /**
     * Name of the alias.
     * @type {string}
     * @memberof Alias
     */
    name?: string;
    /**
     * State of the alias.
     * @type {string}
     * @memberof Alias
     */
    state?: Alias.StateEnum;
    /**
     * Name of the workspace.
     * @type {string}
     * @memberof Alias
     */
    workspace?: string;
}
/**
 * @export
 * @namespace Alias
 */
export declare namespace Alias {
    /**
     * @export
     * @enum {string}
     */
    enum StateEnum {
        CREATED,
        DELETED
    }
}
/**
 * API keys are used to authenticate requests to Rockset's API. An API key is tied to the user who creates it.
 * @export
 * @interface ApiKey
 */
export interface ApiKey {
    /**
     * Date that API key was created (ISO-8601 format).
     * @type {string}
     * @memberof ApiKey
     */
    created_at?: string;
    /**
     * Email of API key owner.
     * @type {string}
     * @memberof ApiKey
     */
    created_by?: string;
    /**
     * Name of the API key that was used to create this object if one was used.
     * @type {string}
     * @memberof ApiKey
     */
    created_by_apikey_name?: string;
    /**
     * The expiration date of this API key.
     * @type {string}
     * @memberof ApiKey
     */
    expiry_time?: string;
    /**
     * This field will only be populated with the full key when creating an API key. Otherwise, it will be an API key identifier of 6 characters.
     * @type {string}
     * @memberof ApiKey
     */
    key: string;
    /**
     * Date that API key was most recently used (ISO-8601 format).
     * @type {string}
     * @memberof ApiKey
     */
    last_access_time?: string;
    /**
     * Name of the API key.
     * @type {string}
     * @memberof ApiKey
     */
    name: string;
    /**
     * Role specifying access control. If not specified, API key will have access to all of the associated user's roles.
     * @type {string}
     * @memberof ApiKey
     */
    role?: string;
    /**
     * Current state of this key.
     * @type {string}
     * @memberof ApiKey
     */
    state?: ApiKey.StateEnum;
}
/**
 * @export
 * @namespace ApiKey
 */
export declare namespace ApiKey {
    /**
     * @export
     * @enum {string}
     */
    enum StateEnum {
        ACTIVE,
        SUSPENDED
    }
}
/**
 *
 * @export
 * @interface AsyncQueryOptions
 */
export interface AsyncQueryOptions {
    /**
     * If the query completes before the client timeout, the results are returned. Otherwise if the client timeout is exceeded, the query id will be returned, and the query will continue to run in the background for up to 30 minutes. (The 30 minute timeout can be configured lower with timeout_ms.) `async_options.client_timeout_ms` only applies when `async` is true. The default value of `client_timeout_ms` is 0, so async query requests will immediately return with a query id by default.
     * @type {number}
     * @memberof AsyncQueryOptions
     */
    client_timeout_ms?: number;
    /**
     * [DEPRECATED] Use the query request `max_initial_results` instead. The maximum number of results you will receive as a client. If the query exceeds this limit, the remaining results can be requested using a returned pagination cursor. In addition, there is a maximum response size of 100MiB so fewer than `max_results` may be returned.
     * @type {number}
     * @memberof AsyncQueryOptions
     */
    max_initial_results?: number;
    /**
     * [DEPRECATED] Use the query request `timeout_ms` instead. The maximum amount of time that the system will attempt to complete query execution before aborting the query and returning an error. This must be set to a value that is greater than or equal to the client timeout, and the maximum value of this timeout is 30 minutes.
     * @type {number}
     * @memberof AsyncQueryOptions
     */
    timeout_ms?: number;
}
/**
 *
 * @export
 * @interface AutoScalingPolicy
 */
export interface AutoScalingPolicy {
    /**
     * Whether auto scaling policy is enabled.
     * @type {boolean}
     * @memberof AutoScalingPolicy
     */
    enabled?: boolean;
    /**
     * Maximum size Rockset can auto scale the Virtual Instance to. This value should be one of the dedicated sizes greater than or same as the min_size and lower than or same as the current size.
     * @type {string}
     * @memberof AutoScalingPolicy
     */
    max_size?: AutoScalingPolicy.MaxSizeEnum;
    /**
     * Minimum size Rockset can auto scale the Virtual Instance to. This value should be one of the dedicated sizes lower than or same as the max_size and greater than or same as the current size.
     * @type {string}
     * @memberof AutoScalingPolicy
     */
    min_size?: AutoScalingPolicy.MinSizeEnum;
}
/**
 * @export
 * @namespace AutoScalingPolicy
 */
export declare namespace AutoScalingPolicy {
    /**
     * @export
     * @enum {string}
     */
    enum MaxSizeEnum {
        FREE,
        NANO,
        SHARED,
        MILLI,
        XSMALL,
        SMALL,
        MEDIUM,
        LARGE,
        XLARGE,
        XLARGE2,
        XLARGE4,
        XLARGE8,
        XLARGE16
    }
    /**
     * @export
     * @enum {string}
     */
    enum MinSizeEnum {
        FREE,
        NANO,
        SHARED,
        MILLI,
        XSMALL,
        SMALL,
        MEDIUM,
        LARGE,
        XLARGE,
        XLARGE2,
        XLARGE4,
        XLARGE8,
        XLARGE16
    }
}
/**
 *
 * @export
 * @interface AvroParams
 */
export interface AvroParams {
}
/**
 *
 * @export
 * @interface AwsAccessKey
 */
export interface AwsAccessKey {
    /**
     * AWS access key ID.
     * @type {string}
     * @memberof AwsAccessKey
     */
    aws_access_key_id: string;
    /**
     * AWS secret access key.
     * @type {string}
     * @memberof AwsAccessKey
     */
    aws_secret_access_key: string;
}
/**
 *
 * @export
 * @interface AwsRole
 */
export interface AwsRole {
    /**
     * External id used for integration.
     * @type {string}
     * @memberof AwsRole
     */
    aws_external_id?: string;
    /**
     * ARN of rockset-role created in your account.
     * @type {string}
     * @memberof AwsRole
     */
    aws_role_arn: string;
}
/**
 *
 * @export
 * @interface AzureBlobStorageIntegration
 */
export interface AzureBlobStorageIntegration {
    /**
     * Credentials for the Azure Blob Service.
     * @type {string}
     * @memberof AzureBlobStorageIntegration
     */
    connection_string: string;
}
/**
 *
 * @export
 * @interface AzureEventHubsIntegration
 */
export interface AzureEventHubsIntegration {
    /**
     * Credentials for the Azure Event Hubs.
     * @type {string}
     * @memberof AzureEventHubsIntegration
     */
    connection_string?: string;
}
/**
 *
 * @export
 * @interface AzureServiceBusIntegration
 */
export interface AzureServiceBusIntegration {
    /**
     * Credentials for the Azure Service Bus.
     * @type {string}
     * @memberof AzureServiceBusIntegration
     */
    connection_string: string;
}
/**
 *
 * @export
 * @interface BulkStats
 */
export interface BulkStats {
    /**
     * Size in bytes of documents downloaded from source during an ongoing or completed bulk ingest. This includes documents that are dropped and reingested.
     * @type {number}
     * @memberof BulkStats
     */
    data_downloaded_bytes?: number;
    /**
     * Size in bytes of documents indexed. This is the total size of documents after transformations and dropping before indexes are built.
     * @type {number}
     * @memberof BulkStats
     */
    data_indexed_bytes?: number;
    /**
     * Throughput of documents indexed in the last minute measured in bytes/s. This is based off the data_indexed_bytes size. Throughput during the download stage is shown on a per-source granularity in the sources field of the Collection response.
     * @type {number}
     * @memberof BulkStats
     */
    data_indexed_throughput_bytes?: number;
    /**
     * Number of documents downloaded from source during an ongoing or completed bulk ingest. This includes documents that are dropped and reingested.
     * @type {number}
     * @memberof BulkStats
     */
    documents_downloaded?: number;
    /**
     * Bulk ingest compute units in milliseconds used for downloading documents.
     * @type {number}
     * @memberof BulkStats
     */
    download_compute_ms?: number;
    /**
     * ISO-8601 date of when the downloading stage was completed.
     * @type {string}
     * @memberof BulkStats
     */
    downloading_stage_done_at?: string;
    /**
     * ISO-8601 date of when the finalizing stage was completed.
     * @type {string}
     * @memberof BulkStats
     */
    finalizing_stage_done_at?: string;
    /**
     * Bulk ingest compute units in milliseconds used for indexing documents.
     * @type {number}
     * @memberof BulkStats
     */
    index_compute_ms?: number;
    /**
     * ISO-8601 date of when the indexing stage was completed.
     * @type {string}
     * @memberof BulkStats
     */
    indexing_stage_done_at?: string;
    /**
     * ISO-8601 date of when the initializing stage was completed.
     * @type {string}
     * @memberof BulkStats
     */
    initializing_stage_done_at?: string;
    /**
     * Size in bytes of documents before being indexed. This is the total size of documents after decompression, transformations, and dropping. This is equal to data_indexed_bytes after the indexing stage is done unless there are retries during indexing the data.
     * @type {number}
     * @memberof BulkStats
     */
    pre_index_size_bytes?: number;
    /**
     * ISO-8601 date of when the provisioning stage was completed.
     * @type {string}
     * @memberof BulkStats
     */
    provisioning_stage_done_at?: string;
    /**
     * ISO-8601 date of when the bulk ingest was started.
     * @type {string}
     * @memberof BulkStats
     */
    started_at?: string;
    /**
     * Total size of indexes after the completed bulk ingest. This is the same as collection size.
     * @type {number}
     * @memberof BulkStats
     */
    total_index_size_bytes?: number;
    /**
     * Bulk ingest compute units in milliseconds used for ingest transformation.
     * @type {number}
     * @memberof BulkStats
     */
    transformation_compute_ms?: number;
}
/**
 *
 * @export
 * @interface CancelQueryResponse
 */
export interface CancelQueryResponse {
    /**
     *
     * @type {QueryInfo}
     * @memberof CancelQueryResponse
     */
    data?: QueryInfo;
}
/**
 *
 * @export
 * @interface Cluster
 */
export interface Cluster {
    /**
     * Api server url for cluster.
     * @type {string}
     * @memberof Cluster
     */
    apiserver_url?: string;
    /**
     * Aws region.
     * @type {string}
     * @memberof Cluster
     */
    aws_region?: string;
    /**
     * Cluster type.
     * @type {string}
     * @memberof Cluster
     */
    cluster_type?: Cluster.ClusterTypeEnum;
    /**
     * Domain of org using cluster.
     * @type {string}
     * @memberof Cluster
     */
    domain?: string;
    /**
     * Unique identifier for the cluster.
     * @type {string}
     * @memberof Cluster
     */
    id?: string;
    /**
     * Top level domain of org using cluster.
     * @type {string}
     * @memberof Cluster
     */
    top_level_domain?: string;
}
/**
 * @export
 * @namespace Cluster
 */
export declare namespace Cluster {
    /**
     * @export
     * @enum {string}
     */
    enum ClusterTypeEnum {
        PUBLIC
    }
}
/**
 *
 * @export
 * @interface Collection
 */
export interface Collection {
    /**
     * List of aliases for a collection.
     * @type {Array<Alias>}
     * @memberof Collection
     */
    aliases?: Array<Alias>;
    /**
     *
     * @type {Array<BulkStats>}
     * @memberof Collection
     */
    bulk_stats?: Array<BulkStats>;
    /**
     * List of clustering fields for a collection.
     * @type {Array<FieldPartition>}
     * @memberof Collection
     */
    clustering_key?: Array<FieldPartition>;
    /**
     * ISO-8601 date.
     * @type {string}
     * @memberof Collection
     */
    created_at?: string;
    /**
     * Email of user who created the collection.
     * @type {string}
     * @memberof Collection
     */
    created_by?: string;
    /**
     * Name of the API key that was used to create this collection if one was used.
     * @type {string}
     * @memberof Collection
     */
    created_by_apikey_name?: string;
    /**
     * Text describing the collection.
     * @type {string}
     * @memberof Collection
     */
    description?: string;
    /**
     * Field mapping for a collection.
     * @type {FieldMappingQuery}
     * @memberof Collection
     */
    field_mapping_query?: FieldMappingQuery;
    /**
     * List of mappings applied on all documents in a collection.
     * @type {Array<FieldMappingV2>}
     * @memberof Collection
     */
    field_mappings?: Array<FieldMappingV2>;
    /**
     * Whether the collection is insert only or not.
     * @type {boolean}
     * @memberof Collection
     */
    insert_only?: boolean;
    /**
     * Unique identifer for collection, can contain alphanumeric or dash characters.
     * @type {string}
     * @memberof Collection
     */
    name?: string;
    /**
     * Whether the collection is read-only or not.
     * @type {boolean}
     * @memberof Collection
     */
    read_only?: boolean;
    /**
     * Number of seconds after which data is purged based on event time.
     * @type {number}
     * @memberof Collection
     */
    retention_secs?: number;
    /**
     * Collection RRN.
     * @type {string}
     * @memberof Collection
     */
    rrn?: string;
    /**
     * List of sources from which collection ingests.
     * @type {Array<Source>}
     * @memberof Collection
     */
    sources?: Array<Source>;
    /**
     * Metrics about the collection.
     * @type {CollectionStats}
     * @memberof Collection
     */
    stats?: CollectionStats;
    /**
     * Current status of collection.
     * @type {string}
     * @memberof Collection
     */
    status?: Collection.StatusEnum;
    /**
     * RocksDB storage compression type.
     * @type {string}
     * @memberof Collection
     */
    storage_compression_type?: Collection.StorageCompressionTypeEnum;
    /**
     * Name of the workspace that the collection is in.
     * @type {string}
     * @memberof Collection
     */
    workspace?: string;
}
/**
 * @export
 * @namespace Collection
 */
export declare namespace Collection {
    /**
     * @export
     * @enum {string}
     */
    enum StatusEnum {
        INITIALIZED,
        CREATED,
        READY,
        PAUSED,
        DELETED,
        PAUSING,
        RESUMING,
        PREPARINGBULK,
        BULKINGESTMODE,
        EXITINGBULKINGESTMODE,
        ENCRYPTIONKEYERROR,
        UNKNOWN
    }
    /**
     * @export
     * @enum {string}
     */
    enum StorageCompressionTypeEnum {
        LZ4,
        ZSTD,
        UNKNOWN
    }
}
/**
 *
 * @export
 * @interface CollectionMount
 */
export interface CollectionMount {
    /**
     * Collection path.
     * @type {string}
     * @memberof CollectionMount
     */
    collection_path?: string;
    /**
     * ISO-8601 date.
     * @type {string}
     * @memberof CollectionMount
     */
    created_at?: string;
    /**
     * Mount ID.
     * @type {string}
     * @memberof CollectionMount
     */
    id?: string;
    /**
     * Unix timestamp of most recent refresh. Not applicable for live mounts.
     * @type {number}
     * @memberof CollectionMount
     */
    last_refresh_time_millis?: number;
    /**
     * Mount RRN.
     * @type {string}
     * @memberof CollectionMount
     */
    rrn?: string;
    /**
     * Time in millis at which the snapshot expires.
     * @type {number}
     * @memberof CollectionMount
     */
    snapshot_expiration_time_millis?: number;
    /**
     * Mount type.
     * @type {string}
     * @memberof CollectionMount
     */
    state?: CollectionMount.StateEnum;
    /**
     * Stats about this Collection Mount
     * @type {CollectionMountStats}
     * @memberof CollectionMount
     */
    stats?: CollectionMountStats;
    /**
     * Virtual instance ID.
     * @type {string}
     * @memberof CollectionMount
     */
    virtual_instance_id?: string;
    /**
     * Virtual Instance RRN.
     * @type {string}
     * @memberof CollectionMount
     */
    virtual_instance_rrn?: string;
}
/**
 * @export
 * @namespace CollectionMount
 */
export declare namespace CollectionMount {
    /**
     * @export
     * @enum {string}
     */
    enum StateEnum {
        CREATING,
        ACTIVE,
        REFRESHING,
        EXPIRED,
        DELETING,
        SWITCHINGREFRESHTYPE,
        SUSPENDED,
        SUSPENDING
    }
}
/**
 *
 * @export
 * @interface CollectionMountResponse
 */
export interface CollectionMountResponse {
    /**
     * Resource mount object.
     * @type {CollectionMount}
     * @memberof CollectionMountResponse
     */
    data?: CollectionMount;
}
/**
 *
 * @export
 * @interface CollectionMountStats
 */
export interface CollectionMountStats {
    /**
     * Milliseconds since Unix epoch Jan 1, 1970.
     * @type {number}
     * @memberof CollectionMountStats
     */
    last_queried_ms?: number;
}
/**
 *
 * @export
 * @interface CollectionStats
 */
export interface CollectionStats {
    /**
     * Total number of bytes inserted into the collection during bulk.
     * @type {number}
     * @memberof CollectionStats
     */
    bulk_bytes_inserted?: number;
    /**
     * Total number of bytes overwritten in writing into the collection during bulk.
     * @type {number}
     * @memberof CollectionStats
     */
    bulk_bytes_overwritten?: number;
    /**
     * Total number of bytes inserted into the collection.
     * @type {number}
     * @memberof CollectionStats
     */
    bytes_inserted?: number;
    /**
     * Total number of bytes overwritten in writing into the collection.
     * @type {number}
     * @memberof CollectionStats
     */
    bytes_overwritten?: number;
    /**
     * Total collection column index size in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    column_index_size?: number;
    /**
     * Number of documents in the collection.
     * @type {number}
     * @memberof CollectionStats
     */
    doc_count?: number;
    /**
     * Number between 0 and 1 that indicates progress of collection creation.
     * @type {number}
     * @memberof CollectionStats
     */
    fill_progress?: number;
    /**
     * Total collection inverted index size in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    inverted_index_size?: number;
    /**
     * Milliseconds since Unix epoch Jan 1, 1970.
     * @type {number}
     * @memberof CollectionStats
     */
    last_queried_ms?: number;
    /**
     * Milliseconds since Unix epoch Jan 1, 1970.
     * @type {number}
     * @memberof CollectionStats
     */
    last_updated_ms?: number;
    /**
     * Number of documents purged from the collection.
     * @type {number}
     * @memberof CollectionStats
     */
    purged_doc_count?: number;
    /**
     * Total size of bytes purged in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    purged_doc_size?: number;
    /**
     * Total collection range index size in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    range_index_size?: number;
    /**
     * Total collection row index size in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    row_index_size?: number;
    /**
     * Total collection index size in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    total_index_size?: number;
    /**
     * Total collection size in bytes.
     * @type {number}
     * @memberof CollectionStats
     */
    total_size?: number;
}
/**
 *
 * @export
 * @interface CreateAliasRequest
 */
export interface CreateAliasRequest {
    /**
     * List of fully qualified collection names referenced by alias.
     * @type {Array<string>}
     * @memberof CreateAliasRequest
     */
    collections: Array<string>;
    /**
     * Optional description.
     * @type {string}
     * @memberof CreateAliasRequest
     */
    description?: string;
    /**
     * Alias name.
     * @type {string}
     * @memberof CreateAliasRequest
     */
    name: string;
}
/**
 *
 * @export
 * @interface CreateAliasResponse
 */
export interface CreateAliasResponse {
    /**
     * Alias that was created.
     * @type {Alias}
     * @memberof CreateAliasResponse
     */
    data?: Alias;
}
/**
 *
 * @export
 * @interface CreateApiKeyRequest
 */
export interface CreateApiKeyRequest {
    /**
     *
     * @type {string}
     * @memberof CreateApiKeyRequest
     */
    created_by?: string;
    /**
     * If provided, the API key will automatically expire at this time (ISO-8601 format). Requires premium.
     * @type {string}
     * @memberof CreateApiKeyRequest
     */
    expiry_time?: string;
    /**
     * Name for this API key.
     * @type {string}
     * @memberof CreateApiKeyRequest
     */
    name: string;
    /**
     *
     * @type {string}
     * @memberof CreateApiKeyRequest
     */
    role?: string;
}
/**
 *
 * @export
 * @interface CreateApiKeyResponse
 */
export interface CreateApiKeyResponse {
    /**
     * The API key that was created.
     * @type {ApiKey}
     * @memberof CreateApiKeyResponse
     */
    data?: ApiKey;
}
/**
 *
 * @export
 * @interface CreateCollectionMountRequest
 */
export interface CreateCollectionMountRequest {
    /**
     * Collections to mount.
     * @type {Array<string>}
     * @memberof CreateCollectionMountRequest
     */
    collection_paths?: Array<string>;
}
/**
 *
 * @export
 * @interface CreateCollectionMountsResponse
 */
export interface CreateCollectionMountsResponse {
    /**
     * Mounts created.
     * @type {Array<CollectionMount>}
     * @memberof CreateCollectionMountsResponse
     */
    data?: Array<CollectionMount>;
}
/**
 *
 * @export
 * @interface CreateCollectionRequest
 */
export interface CreateCollectionRequest {
    /**
     * Deprecated. List of clustering fields. Use CLUSTER BY clause in `field_mapping_query` instead.
     * @type {Array<FieldPartition>}
     * @memberof CreateCollectionRequest
     */
    clustering_key?: Array<FieldPartition>;
    /**
     * Text describing the collection.
     * @type {string}
     * @memberof CreateCollectionRequest
     */
    description?: string;
    /**
     * Deprecated. Configuration for event data. Use an _event_time mapping in `field_mapping_query` instead.
     * @type {EventTimeInfo}
     * @memberof CreateCollectionRequest
     */
    event_time_info?: EventTimeInfo;
    /**
     * Ingest transformation query.
     * @type {FieldMappingQuery}
     * @memberof CreateCollectionRequest
     */
    field_mapping_query?: FieldMappingQuery;
    /**
     * Unique identifier for collection, can contain alphanumeric or dash characters.
     * @type {string}
     * @memberof CreateCollectionRequest
     */
    name?: string;
    /**
     * Number of seconds after which data is purged, based on event time. Minimum allowable value is 3600s/1 hour. The maximum value is strictly less than 10 years.
     * @type {number}
     * @memberof CreateCollectionRequest
     */
    retention_secs?: number;
    /**
     * Soft ingest limit for this collection.
     * @type {number}
     * @memberof CreateCollectionRequest
     */
    source_download_soft_limit_bytes?: number;
    /**
     * List of sources from which to ingest data.
     * @type {Array<Source>}
     * @memberof CreateCollectionRequest
     */
    sources?: Array<Source>;
    /**
     * RocksDB storage compression type.
     * @type {string}
     * @memberof CreateCollectionRequest
     */
    storage_compression_type?: CreateCollectionRequest.StorageCompressionTypeEnum;
}
/**
 * @export
 * @namespace CreateCollectionRequest
 */
export declare namespace CreateCollectionRequest {
    /**
     * @export
     * @enum {string}
     */
    enum StorageCompressionTypeEnum {
        LZ4,
        ZSTD
    }
}
/**
 *
 * @export
 * @interface CreateCollectionResponse
 */
export interface CreateCollectionResponse {
    /**
     * Collection that was created.
     * @type {Collection}
     * @memberof CreateCollectionResponse
     */
    data?: Collection;
}
/**
 *
 * @export
 * @interface CreateIntegrationRequest
 */
export interface CreateIntegrationRequest {
    /**
     * Azure Blob Storage details.
     * @type {AzureBlobStorageIntegration}
     * @memberof CreateIntegrationRequest
     */
    azure_blob_storage?: AzureBlobStorageIntegration;
    /**
     * Azure Event Hubs details.
     * @type {AzureEventHubsIntegration}
     * @memberof CreateIntegrationRequest
     */
    azure_event_hubs?: AzureEventHubsIntegration;
    /**
     * Azure Service Bus details.
     * @type {AzureServiceBusIntegration}
     * @memberof CreateIntegrationRequest
     */
    azure_service_bus?: AzureServiceBusIntegration;
    /**
     * Longer explanation for the integration.
     * @type {string}
     * @memberof CreateIntegrationRequest
     */
    description?: string;
    /**
     * Amazon DynamoDB details, must have one of aws_access_key or aws_role.
     * @type {DynamodbIntegration}
     * @memberof CreateIntegrationRequest
     */
    dynamodb?: DynamodbIntegration;
    /**
     * GCS details.
     * @type {GcsIntegration}
     * @memberof CreateIntegrationRequest
     */
    gcs?: GcsIntegration;
    /**
     * is write access enabled for this integration.
     * @type {boolean}
     * @memberof CreateIntegrationRequest
     */
    is_write_enabled?: boolean;
    /**
     *
     * @type {KafkaIntegration}
     * @memberof CreateIntegrationRequest
     */
    kafka?: KafkaIntegration;
    /**
     * Amazon Kinesis details, must have one of aws_access_key or aws_role.
     * @type {KinesisIntegration}
     * @memberof CreateIntegrationRequest
     */
    kinesis?: KinesisIntegration;
    /**
     * MongoDb details.
     * @type {MongoDbIntegration}
     * @memberof CreateIntegrationRequest
     */
    mongodb?: MongoDbIntegration;
    /**
     * Descriptive label.
     * @type {string}
     * @memberof CreateIntegrationRequest
     */
    name: string;
    /**
     * Amazon S3 details, must have one of aws_access_key or aws_role.
     * @type {S3Integration}
     * @memberof CreateIntegrationRequest
     */
    s3?: S3Integration;
    /**
     * Snowflake details.
     * @type {SnowflakeIntegration}
     * @memberof CreateIntegrationRequest
     */
    snowflake?: SnowflakeIntegration;
}
/**
 *
 * @export
 * @interface CreateIntegrationResponse
 */
export interface CreateIntegrationResponse {
    /**
     * Integration object that was created.
     * @type {Integration}
     * @memberof CreateIntegrationResponse
     */
    data?: Integration;
}
/**
 *
 * @export
 * @interface CreateQueryLambdaRequest
 */
export interface CreateQueryLambdaRequest {
    /**
     * Optional description.
     * @type {string}
     * @memberof CreateQueryLambdaRequest
     */
    description?: string;
    /**
     *
     * @type {boolean}
     * @memberof CreateQueryLambdaRequest
     */
    is_public?: boolean;
    /**
     * Query Lambda name.
     * @type {string}
     * @memberof CreateQueryLambdaRequest
     */
    name: string;
    /**
     * Query Lambda SQL query.
     * @type {QueryLambdaSql}
     * @memberof CreateQueryLambdaRequest
     */
    sql: QueryLambdaSql;
}
/**
 *
 * @export
 * @interface CreateQueryLambdaTagRequest
 */
export interface CreateQueryLambdaTagRequest {
    /**
     * Name of Query Lambda tag.
     * @type {string}
     * @memberof CreateQueryLambdaTagRequest
     */
    tag_name: string;
    /**
     * Hash identifying a Query Lambda tag.
     * @type {string}
     * @memberof CreateQueryLambdaTagRequest
     */
    version: string;
}
/**
 *
 * @export
 * @interface CreateRoleRequest
 */
export interface CreateRoleRequest {
    /**
     * Description for the role.
     * @type {string}
     * @memberof CreateRoleRequest
     */
    description?: string;
    /**
     * List of privileges that will be associated with the role.
     * @type {Array<Privilege>}
     * @memberof CreateRoleRequest
     */
    privileges?: Array<Privilege>;
    /**
     * Unique identifier for the role.
     * @type {string}
     * @memberof CreateRoleRequest
     */
    role_name?: string;
}
/**
 *
 * @export
 * @interface CreateScheduledLambdaRequest
 */
export interface CreateScheduledLambdaRequest {
    /**
     * The apikey to use when triggering execution of the associated query lambda.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    apikey?: string;
    /**
     * The UNIX-formatted cron string for this scheduled query lambda.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    cron_string: string;
    /**
     * The name of the QL to use for scheduled execution.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    ql_name: string;
    /**
     * The QL tag to use for scheduled execution.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    tag?: string;
    /**
     * The number of times to execute this scheduled query lambda. Once this scheduled query lambda has been executed this many times, it will no longer be executed.
     * @type {number}
     * @memberof CreateScheduledLambdaRequest
     */
    total_times_to_execute?: number;
    /**
     * The version of the QL to use for scheduled execution.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    version?: string;
    /**
     * The value to use as the authorization header when hitting the webhook.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    webhook_auth_header?: string;
    /**
     * The payload that should be sent to the webhook. JSON format.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    webhook_payload?: string;
    /**
     * The URL of the webhook that should be triggered after this scheduled query lambda completes.
     * @type {string}
     * @memberof CreateScheduledLambdaRequest
     */
    webhook_url?: string;
}
/**
 *
 * @export
 * @interface CreateUserRequest
 */
export interface CreateUserRequest {
    /**
     * User email, must be unique.
     * @type {string}
     * @memberof CreateUserRequest
     */
    email: string;
    /**
     * User first name.
     * @type {string}
     * @memberof CreateUserRequest
     */
    first_name?: string;
    /**
     * User last name.
     * @type {string}
     * @memberof CreateUserRequest
     */
    last_name?: string;
    /**
     * List of roles for a given user.
     * @type {Array<string>}
     * @memberof CreateUserRequest
     */
    roles: Array<string>;
}
/**
 *
 * @export
 * @interface CreateUserResponse
 */
export interface CreateUserResponse {
    /**
     * User that was created.
     * @type {User}
     * @memberof CreateUserResponse
     */
    data?: User;
}
/**
 *
 * @export
 * @interface CreateViewRequest
 */
export interface CreateViewRequest {
    /**
     * Optional description.
     * @type {string}
     * @memberof CreateViewRequest
     */
    description?: string;
    /**
     * View name.
     * @type {string}
     * @memberof CreateViewRequest
     */
    name: string;
    /**
     * SQL for this view.
     * @type {string}
     * @memberof CreateViewRequest
     */
    query: string;
}
/**
 *
 * @export
 * @interface CreateViewResponse
 */
export interface CreateViewResponse {
    /**
     * View that was updated.
     * @type {View}
     * @memberof CreateViewResponse
     */
    data?: View;
}
/**
 *
 * @export
 * @interface CreateVirtualInstanceRequest
 */
export interface CreateVirtualInstanceRequest {
    /**
     * Number of seconds without queries after which the VI is suspended
     * @type {number}
     * @memberof CreateVirtualInstanceRequest
     */
    auto_suspend_seconds?: number;
    /**
     * Description of requested virtual instance.
     * @type {string}
     * @memberof CreateVirtualInstanceRequest
     */
    description?: string;
    /**
     * When a Virtual Instance is resumed, it will remount all collections that were mounted when the Virtual Instance was suspended.
     * @type {boolean}
     * @memberof CreateVirtualInstanceRequest
     */
    enable_remount_on_resume?: boolean;
    /**
     * Virtual Instance Class. Use `MO_IL` for Memory Optimized and `GP_IL` for General Purpose instance class.
     * @type {string}
     * @memberof CreateVirtualInstanceRequest
     */
    instance_class?: CreateVirtualInstanceRequest.InstanceClassEnum;
    /**
     * DEPRECATED. Use `mount_type` instead. Number of seconds between data refreshes for mounts on this Virtual Instance. The only valid values are 0 and null. 0 means the data will be refreshed continuously and null means the data will never refresh.
     * @type {number}
     * @memberof CreateVirtualInstanceRequest
     */
    mount_refresh_interval_seconds?: number;
    /**
     * The mount type of collections that this Virtual Instance will query. Live mounted collections stay up-to-date with the underlying collection in real-time. Static mounted collections do not stay up-to-date. See https://docs.rockset.com/documentation/docs/using-virtual-instances#virtual-instance-configuration
     * @type {string}
     * @memberof CreateVirtualInstanceRequest
     */
    mount_type?: CreateVirtualInstanceRequest.MountTypeEnum;
    /**
     * Unique identifier for virtual instance, can contain alphanumeric or dash characters.
     * @type {string}
     * @memberof CreateVirtualInstanceRequest
     */
    name: string;
    /**
     * Requested virtual instance type.
     * @type {string}
     * @memberof CreateVirtualInstanceRequest
     */
    type?: CreateVirtualInstanceRequest.TypeEnum;
}
/**
 * @export
 * @namespace CreateVirtualInstanceRequest
 */
export declare namespace CreateVirtualInstanceRequest {
    /**
     * @export
     * @enum {string}
     */
    enum InstanceClassEnum {
        MOIL,
        GPIL
    }
    /**
     * @export
     * @enum {string}
     */
    enum MountTypeEnum {
        LIVE,
        STATIC
    }
    /**
     * @export
     * @enum {string}
     */
    enum TypeEnum {
        FREE,
        NANO,
        SHARED,
        MILLI,
        XSMALL,
        SMALL,
        MEDIUM,
        LARGE,
        XLARGE,
        XLARGE2,
        XLARGE4,
        XLARGE8,
        XLARGE16
    }
}
/**
 *
 * @export
 * @interface CreateVirtualInstanceResponse
 */
export interface CreateVirtualInstanceResponse {
    /**
     * Virtual instance object.
     * @type {VirtualInstance}
     * @memberof CreateVirtualInstanceResponse
     */
    data?: VirtualInstance;
}
/**
 *
 * @export
 * @interface CreateWorkspaceRequest
 */
export interface CreateWorkspaceRequest {
    /**
     * Longer explanation for the workspace.
     * @type {string}
     * @memberof CreateWorkspaceRequest
     */
    description?: string;
    /**
     * Descriptive label and unique identifier.
     * @type {string}
     * @memberof CreateWorkspaceRequest
     */
    name: string;
}
/**
 *
 * @export
 * @interface CreateWorkspaceResponse
 */
export interface CreateWorkspaceResponse {
    /**
     * The workspace that was created.
     * @type {Workspace}
     * @memberof CreateWorkspaceResponse
     */
    data?: Workspace;
}
/**
 *
 * @export
 * @interface CsvParams
 */
export interface CsvParams {
    /**
     * Names of columns.
     * @type {Array<string>}
     * @memberof CsvParams
     */
    columnNames?: Array<string>;
    /**
     * Names of columns.
     * @type {Array<string>}
     * @memberof CsvParams
     */
    columnTypes?: Array<CsvParams.ColumnTypesEnum>;
    /**
     * One of: UTF-8, ISO_8859_1, UTF-16.
     * @type {string}
     * @memberof CsvParams
     */
    encoding?: string;
    /**
     * escape character removes any special meaning from the following character,default is '\\'
     * @type {string}
     * @memberof CsvParams
     */
    escapeChar?: string;
    /**
     * If the first line in every object specifies the column names.
     * @type {boolean}
     * @memberof CsvParams
     */
    firstLineAsColumnNames?: boolean;
    /**
     * character within which a cell value is enclosed,null character if no such character, default is '\"'
     * @type {string}
     * @memberof CsvParams
     */
    quoteChar?: string;
    /**
     * A single character that is the column separator.
     * @type {string}
     * @memberof CsvParams
     */
    separator?: string;
}
/**
 * @export
 * @namespace CsvParams
 */
export declare namespace CsvParams {
    /**
     * @export
     * @enum {string}
     */
    enum ColumnTypesEnum {
        UNKNOWN,
        BOOLEAN,
        BOOL,
        INTEGER,
        INT,
        FLOAT,
        TIME,
        DATE,
        DATETIME,
        TIMESTAMP,
        STRING
    }
}
/**
 *
 * @export
 * @interface DeleteAliasResponse
 */
export interface DeleteAliasResponse {
    /**
     * Alias that was deleted.
     * @type {Alias}
     * @memberof DeleteAliasResponse
     */
    data?: Alias;
}
/**
 *
 * @export
 * @interface DeleteApiKeyResponse
 */
export interface DeleteApiKeyResponse {
    /**
     * The API key that was deleted.
     * @type {ApiKey}
     * @memberof DeleteApiKeyResponse
     */
    data?: ApiKey;
}
/**
 *
 * @export
 * @interface DeleteCollectionResponse
 */
export interface DeleteCollectionResponse {
    /**
     * Collection that was deleted.
     * @type {Collection}
     * @memberof DeleteCollectionResponse
     */
    data?: Collection;
}
/**
 *
 * @export
 * @interface DeleteDocumentsRequest
 */
export interface DeleteDocumentsRequest {
    /**
     * Array of IDs of documents to be deleted.
     * @type {Array<DeleteDocumentsRequestData>}
     * @memberof DeleteDocumentsRequest
     */
    data: Array<DeleteDocumentsRequestData>;
}
/**
 *
 * @export
 * @interface DeleteDocumentsRequestData
 */
export interface DeleteDocumentsRequestData {
    /**
     * Unique document ID.
     * @type {string}
     * @memberof DeleteDocumentsRequestData
     */
    _id: string;
}
/**
 *
 * @export
 * @interface DeleteDocumentsResponse
 */
export interface DeleteDocumentsResponse {
    /**
     * Information about deleted documents.
     * @type {Array<DocumentStatus>}
     * @memberof DeleteDocumentsResponse
     */
    data?: Array<DocumentStatus>;
    /**
     * A string representing the collection offset after completing the deletes.
     * @type {string}
     * @memberof DeleteDocumentsResponse
     */
    last_offset?: string;
}
/**
 *
 * @export
 * @interface DeleteIntegrationResponse
 */
export interface DeleteIntegrationResponse {
    /**
     * Integration object that was deleted.
     * @type {Integration}
     * @memberof DeleteIntegrationResponse
     */
    data?: Integration;
}
/**
 *
 * @export
 * @interface DeleteQueryLambdaResponse
 */
export interface DeleteQueryLambdaResponse {
    /**
     * Query Lambda details.
     * @type {QueryLambda}
     * @memberof DeleteQueryLambdaResponse
     */
    data?: QueryLambda;
}
/**
 *
 * @export
 * @interface DeleteSourceResponse
 */
export interface DeleteSourceResponse {
    /**
     * source that was deleted
     * @type {Source}
     * @memberof DeleteSourceResponse
     */
    data?: Source;
}
/**
 *
 * @export
 * @interface DeleteUserResponse
 */
export interface DeleteUserResponse {
    /**
     * User object that was deleted.
     * @type {User}
     * @memberof DeleteUserResponse
     */
    data?: User;
}
/**
 *
 * @export
 * @interface DeleteViewResponse
 */
export interface DeleteViewResponse {
    /**
     * View that was deleted.
     * @type {View}
     * @memberof DeleteViewResponse
     */
    data?: View;
}
/**
 *
 * @export
 * @interface DeleteVirtualInstanceResponse
 */
export interface DeleteVirtualInstanceResponse {
    /**
     * Virtual instance that was deleted.
     * @type {VirtualInstance}
     * @memberof DeleteVirtualInstanceResponse
     */
    data?: VirtualInstance;
}
/**
 *
 * @export
 * @interface DeleteWorkspaceResponse
 */
export interface DeleteWorkspaceResponse {
    /**
     * The workspace that was deleted.
     * @type {Workspace}
     * @memberof DeleteWorkspaceResponse
     */
    data?: Workspace;
}
/**
 *
 * @export
 * @interface DeploymentSettings
 */
export interface DeploymentSettings {
    /**
     * RRN of the Virtual Instance that all queries will be routed to by default
     * @type {string}
     * @memberof DeploymentSettings
     */
    default_query_vi?: string;
}
/**
 *
 * @export
 * @interface DeploymentSettingsResponse
 */
export interface DeploymentSettingsResponse {
    /**
     * Deployment settings
     * @type {DeploymentSettings}
     * @memberof DeploymentSettingsResponse
     */
    data?: DeploymentSettings;
}
/**
 *
 * @export
 * @interface DocumentStatus
 */
export interface DocumentStatus {
    /**
     * Collection name.
     * @type {string}
     * @memberof DocumentStatus
     */
    _collection?: string;
    /**
     * Unique document ID.
     * @type {string}
     * @memberof DocumentStatus
     */
    _id?: string;
    /**
     * Error message, if any.
     * @type {ErrorModel}
     * @memberof DocumentStatus
     */
    error?: ErrorModel;
    /**
     * Unique id used to represent each patch request.
     * @type {string}
     * @memberof DocumentStatus
     */
    patch_id?: string;
    /**
     * Status of the document.
     * @type {string}
     * @memberof DocumentStatus
     */
    status?: DocumentStatus.StatusEnum;
}
/**
 * @export
 * @namespace DocumentStatus
 */
export declare namespace DocumentStatus {
    /**
     * @export
     * @enum {string}
     */
    enum StatusEnum {
        ADDED,
        REPLACED,
        DELETED,
        PATCHED,
        ERROR
    }
}
/**
 *
 * @export
 * @interface DynamodbIntegration
 */
export interface DynamodbIntegration {
    /**
     * Credentials for an AWS access key integration.
     * @type {AwsAccessKey}
     * @memberof DynamodbIntegration
     */
    aws_access_key?: AwsAccessKey;
    /**
     * Role used for external id type authentication.
     * @type {AwsRole}
     * @memberof DynamodbIntegration
     */
    aws_role?: AwsRole;
    /**
     * S3 bucket used for export during collection initial dump.
     * @type {string}
     * @memberof DynamodbIntegration
     */
    s3_export_bucket_name?: string;
}
/**
 * Describes details about an error
 * @export
 * @interface ErrorModel
 */
export interface ErrorModel {
    /**
     * Column where the error happened (if applicable).
     * @type {number}
     * @memberof ErrorModel
     */
    column?: number;
    /**
     * ID of the error.
     * @type {string}
     * @memberof ErrorModel
     */
    error_id?: string;
    /**
     * Line where the error happened (if applicable).
     * @type {number}
     * @memberof ErrorModel
     */
    line?: number;
    /**
     * Descriptive message about the error.
     * @type {string}
     * @memberof ErrorModel
     */
    message?: string;
    /**
     * ID of the query (if applicable).
     * @type {string}
     * @memberof ErrorModel
     */
    query_id?: string;
    /**
     * Internal trace ID to help with debugging.
     * @type {string}
     * @memberof ErrorModel
     */
    trace_id?: string;
    /**
     * Category of the error.
     * @type {string}
     * @memberof ErrorModel
     */
    type?: ErrorModel.TypeEnum;
}
/**
 * @export
 * @namespace ErrorModel
 */
export declare namespace ErrorModel {
    /**
     * @export
     * @enum {string}
     */
    enum TypeEnum {
        AUTHEXCEPTION,
        VERSIONEXCEPTION,
        INTERNALERROR,
        INVALIDINPUT,
        NOTIMPLEMENTEDYET,
        RESOURCEEXCEEDED,
        ALREADYEXISTS,
        METHODNOTALLOWED,
        NOTACCEPTABLE,
        UNSUPPORTEDMEDIATYPE,
        NOTFOUND,
        DEPENDENTRESOURCES,
        QUERYERROR,
        NOTREADY,
        FORBIDDEN,
        QUERYTIMEOUT,
        CONNECTIONERROR,
        CONTENTTOOLARGE,
        CREATING,
        BADREQUEST,
        SERVICEUNAVAILABLE,
        CONFLICT,
        RATELIMITEXCEEDED,
        QUERYCANCELLED,
        CLIENTCONNECTIONERROR
    }
}
/**
 *
 * @export
 * @interface EventTimeInfo
 */
export interface EventTimeInfo {
    /**
     * Name of the field containing event time.
     * @type {string}
     * @memberof EventTimeInfo
     */
    field: string;
    /**
     * Format of time field, can be one of: milliseconds_since_epoch, seconds_since_epoch.
     * @type {string}
     * @memberof EventTimeInfo
     */
    format?: string;
    /**
     * Default time zone, in standard IANA format.
     * @type {string}
     * @memberof EventTimeInfo
     */
    time_zone?: string;
}
/**
 *
 * @export
 * @interface ExecutePublicQueryLambdaRequest
 */
export interface ExecutePublicQueryLambdaRequest {
    /**
     * Row limit to use if no limit specified in the SQL query text.
     * @type {number}
     * @memberof ExecutePublicQueryLambdaRequest
     */
    default_row_limit?: number;
    /**
     * List of named parameters.
     * @type {Array<QueryParameter>}
     * @memberof ExecutePublicQueryLambdaRequest
     */
    parameters?: Array<QueryParameter>;
}
/**
 *
 * @export
 * @interface ExecuteQueryLambdaRequest
 */
export interface ExecuteQueryLambdaRequest {
    /**
     * If true, the query will run asynchronously for up to 30 minutes. The query request will immediately return with a query id that can be used to retrieve the query status and results. If false or not specified, the query will return with results once completed or timeout after 2 minutes. (To return results directly for shorter queries while still allowing a timeout of up to 30 minutes, set `async_options.client_timeout_ms`.)
     * @type {boolean}
     * @memberof ExecuteQueryLambdaRequest
     */
    async?: boolean;
    /**
     * Options for configuring Asynchronous Query Mode.
     * @type {AsyncQueryOptions}
     * @memberof ExecuteQueryLambdaRequest
     */
    async_options?: AsyncQueryOptions;
    /**
     * If query execution takes longer than this value, debug information will be logged. If the query text includes the DEBUG hint and this parameter is also provided, only this value will be used and the DEBUG hint will be ignored.
     * @type {number}
     * @memberof ExecuteQueryLambdaRequest
     */
    debug_threshold_ms?: number;
    /**
     * Row limit to use if no limit specified in the SQL query text.
     * @type {number}
     * @memberof ExecuteQueryLambdaRequest
     */
    default_row_limi