@ydbjs/api/dist/gen/protos/ydb_import_pb.d.ts

TypeScript gRPC service definitions and protobuf types for all YDB APIs. Enables strongly-typed client generation and low-level protocol access.

import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv2";
import type { EncryptionSettings } from "./ydb_export_pb.js";
import type { Operation, OperationParams } from "./ydb_operation_pb.js";
import type { Timestamp } from "../google/protobuf/timestamp_pb.js";
import type { Message } from "@bufbuild/protobuf";
/**
 * Describes the file protos/ydb_import.proto.
 */
export declare const file_protos_ydb_import: GenFile;
/**
 * / Common
 *
 * @generated from message Ydb.Import.ImportProgress
 */
export type ImportProgress = Message<"Ydb.Import.ImportProgress"> & {};
/**
 * Describes the message Ydb.Import.ImportProgress.
 * Use `create(ImportProgressSchema)` to create a new message.
 */
export declare const ImportProgressSchema: GenMessage<ImportProgress>;
/**
 * @generated from enum Ydb.Import.ImportProgress.Progress
 */
export declare enum ImportProgress_Progress {
    /**
     * @generated from enum value: PROGRESS_UNSPECIFIED = 0;
     */
    UNSPECIFIED = 0,
    /**
     * @generated from enum value: PROGRESS_PREPARING = 1;
     */
    PREPARING = 1,
    /**
     * @generated from enum value: PROGRESS_TRANSFER_DATA = 2;
     */
    TRANSFER_DATA = 2,
    /**
     * @generated from enum value: PROGRESS_BUILD_INDEXES = 3;
     */
    BUILD_INDEXES = 3,
    /**
     * @generated from enum value: PROGRESS_DONE = 4;
     */
    DONE = 4,
    /**
     * @generated from enum value: PROGRESS_CANCELLATION = 5;
     */
    CANCELLATION = 5,
    /**
     * @generated from enum value: PROGRESS_CANCELLED = 6;
     */
    CANCELLED = 6,
    /**
     * @generated from enum value: PROGRESS_CREATE_CHANGEFEEDS = 7;
     */
    CREATE_CHANGEFEEDS = 7
}
/**
 * Describes the enum Ydb.Import.ImportProgress.Progress.
 */
export declare const ImportProgress_ProgressSchema: GenEnum<ImportProgress_Progress>;
/**
 * @generated from message Ydb.Import.ImportItemProgress
 */
export type ImportItemProgress = Message<"Ydb.Import.ImportItemProgress"> & {
    /**
     * @generated from field: uint32 parts_total = 1;
     */
    partsTotal: number;
    /**
     * @generated from field: uint32 parts_completed = 2;
     */
    partsCompleted: number;
    /**
     * @generated from field: google.protobuf.Timestamp start_time = 3;
     */
    startTime?: Timestamp;
    /**
     * @generated from field: google.protobuf.Timestamp end_time = 4;
     */
    endTime?: Timestamp;
};
/**
 * Describes the message Ydb.Import.ImportItemProgress.
 * Use `create(ImportItemProgressSchema)` to create a new message.
 */
export declare const ImportItemProgressSchema: GenMessage<ImportItemProgress>;
/**
 * / S3
 *
 * @generated from message Ydb.Import.ImportFromS3Settings
 */
export type ImportFromS3Settings = Message<"Ydb.Import.ImportFromS3Settings"> & {
    /**
     * @generated from field: string endpoint = 1;
     */
    endpoint: string;
    /**
     * HTTPS if not specified
     *
     * @generated from field: Ydb.Import.ImportFromS3Settings.Scheme scheme = 2;
     */
    scheme: ImportFromS3Settings_Scheme;
    /**
     * @generated from field: string bucket = 3;
     */
    bucket: string;
    /**
     * @generated from field: string access_key = 4;
     */
    accessKey: string;
    /**
     * @generated from field: string secret_key = 5;
     */
    secretKey: string;
    /**
     * Empty collection means import of all export objects
     *
     * @generated from field: repeated Ydb.Import.ImportFromS3Settings.Item items = 6;
     */
    items: ImportFromS3Settings_Item[];
    /**
     * @generated from field: string description = 7;
     */
    description: string;
    /**
     * @generated from field: uint32 number_of_retries = 8;
     */
    numberOfRetries: number;
    /**
     * Region to use in requests
     *
     * @generated from field: string region = 9;
     */
    region: string;
    /**
     * disables virtual hosting style buckets aws s3 feature
     * it changes the way bucket appended to url. e.g. https//bucket_name.example.com/ vs https://example.com/bucket_name
     * details: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html
     * it is especially useful for custom s3 implementations
     *
     * @generated from field: bool disable_virtual_addressing = 10;
     */
    disableVirtualAddressing: boolean;
    /**
     * Prevent importing of ACL and owner. If true, objects are created with empty ACL
     * and their owner will be the user who started the import.
     *
     * @generated from field: bool no_acl = 11;
     */
    noAcl: boolean;
    /**
     * Skip checksum validation during import
     *
     * @generated from field: bool skip_checksum_validation = 12;
     */
    skipChecksumValidation: boolean;
    /**
     * A default path prefix for all items,
     * determines that the import works with the list of objects in the SchemaMapping file.
     * Must be provided to import an encrypted export.
     *
     * @generated from field: string source_prefix = 13;
     */
    sourcePrefix: string;
    /**
     * Destination path to restore paths inside database
     * Default value is database root
     *
     * @generated from field: string destination_path = 14;
     */
    destinationPath: string;
    /**
     * Settings how data is encrypted.
     * If encryption_settings field is not specified,
     * the resulting data is considered not encrypted.
     *
     * @generated from field: Ydb.Export.EncryptionSettings encryption_settings = 15;
     */
    encryptionSettings?: EncryptionSettings;
    /**
     * Index filling mode.
     * If not specified, indexes will be built.
     *
     * @generated from field: Ydb.Import.ImportFromS3Settings.IndexFillingMode index_filling_mode = 16;
     */
    indexFillingMode: ImportFromS3Settings_IndexFillingMode;
    /**
     * Patterns (PCRE) for paths excluded from import operation.
     * - Patterns are matched against the database object names stored in the backup listing.
     * - Object is excluded from import operation if it matches any of the specified exclude regexps.
     *
     * @generated from field: repeated string exclude_regexps = 17;
     */
    excludeRegexps: string[];
};
/**
 * Describes the message Ydb.Import.ImportFromS3Settings.
 * Use `create(ImportFromS3SettingsSchema)` to create a new message.
 */
export declare const ImportFromS3SettingsSchema: GenMessage<ImportFromS3Settings>;
/**
 * @generated from message Ydb.Import.ImportFromS3Settings.Item
 */
export type ImportFromS3Settings_Item = Message<"Ydb.Import.ImportFromS3Settings.Item"> & {
    /**
     * YDB database objects in S3 are stored in one or more S3 objects (see ydb_export.proto).
     * The S3 object name begins with a prefix, followed by:
     * '/data_PartNumber', where 'PartNumber' represents the index of the part, starting at zero;
     * '/scheme.pb' - object with information about scheme, indexes, etc;
     * '/permissions.pb' - object with information about ACL and owner;
     * '/metadata.json' - object with metadata about the backup.
     *
     * @generated from oneof Ydb.Import.ImportFromS3Settings.Item.Source
     */
    Source: {
        /**
         * The S3 object prefix can be either provided explicitly
         *
         * @generated from field: string source_prefix = 1;
         */
        value: string;
        case: "sourcePrefix";
    } | {
        /**
         * Or, if the export contains the database objects list, you may specify the database object name, and the S3 prefix will be looked up in the database objects list by the import procedure
         *
         * @generated from field: string source_path = 3;
         */
        value: string;
        case: "sourcePath";
    } | {
        case: undefined;
        value?: undefined;
    };
    /**
     * Database path to a database object to import the item to
     * Resolved relative to the default destination_path
     * May be omitted if the item's source_path is specified, in this case will be taken equal to it
     *
     * @generated from field: string destination_path = 2;
     */
    destinationPath: string;
};
/**
 * Describes the message Ydb.Import.ImportFromS3Settings.Item.
 * Use `create(ImportFromS3Settings_ItemSchema)` to create a new message.
 */
export declare const ImportFromS3Settings_ItemSchema: GenMessage<ImportFromS3Settings_Item>;
/**
 * @generated from enum Ydb.Import.ImportFromS3Settings.Scheme
 */
export declare enum ImportFromS3Settings_Scheme {
    /**
     * @generated from enum value: UNSPECIFIED = 0;
     */
    UNSPECIFIED = 0,
    /**
     * @generated from enum value: HTTP = 1;
     */
    HTTP = 1,
    /**
     * @generated from enum value: HTTPS = 2;
     */
    HTTPS = 2
}
/**
 * Describes the enum Ydb.Import.ImportFromS3Settings.Scheme.
 */
export declare const ImportFromS3Settings_SchemeSchema: GenEnum<ImportFromS3Settings_Scheme>;
/**
 * @generated from enum Ydb.Import.ImportFromS3Settings.IndexFillingMode
 */
export declare enum ImportFromS3Settings_IndexFillingMode {
    /**
     * If unspecified, use default - Build
     *
     * @generated from enum value: INDEX_FILLING_MODE_UNSPECIFIED = 0;
     */
    UNSPECIFIED = 0,
    /**
     * Build index
     *
     * @generated from enum value: INDEX_FILLING_MODE_BUILD = 1;
     */
    BUILD = 1,
    /**
     * Import materialized index
     *
     * @generated from enum value: INDEX_FILLING_MODE_IMPORT = 2;
     */
    IMPORT = 2,
    /**
     * Try to import materialized index, build otherwise
     *
     * @generated from enum value: INDEX_FILLING_MODE_AUTO = 3;
     */
    AUTO = 3
}
/**
 * Describes the enum Ydb.Import.ImportFromS3Settings.IndexFillingMode.
 */
export declare const ImportFromS3Settings_IndexFillingModeSchema: GenEnum<ImportFromS3Settings_IndexFillingMode>;
/**
 * @generated from message Ydb.Import.ImportFromS3Result
 */
export type ImportFromS3Result = Message<"Ydb.Import.ImportFromS3Result"> & {};
/**
 * Describes the message Ydb.Import.ImportFromS3Result.
 * Use `create(ImportFromS3ResultSchema)` to create a new message.
 */
export declare const ImportFromS3ResultSchema: GenMessage<ImportFromS3Result>;
/**
 * @generated from message Ydb.Import.ImportFromS3Metadata
 */
export type ImportFromS3Metadata = Message<"Ydb.Import.ImportFromS3Metadata"> & {
    /**
     * @generated from field: Ydb.Import.ImportFromS3Settings settings = 1;
     */
    settings?: ImportFromS3Settings;
    /**
     * @generated from field: Ydb.Import.ImportProgress.Progress progress = 2;
     */
    progress: ImportProgress_Progress;
    /**
     * @generated from field: repeated Ydb.Import.ImportItemProgress items_progress = 3;
     */
    itemsProgress: ImportItemProgress[];
};
/**
 * Describes the message Ydb.Import.ImportFromS3Metadata.
 * Use `create(ImportFromS3MetadataSchema)` to create a new message.
 */
export declare const ImportFromS3MetadataSchema: GenMessage<ImportFromS3Metadata>;
/**
 * @generated from message Ydb.Import.ImportFromS3Request
 */
export type ImportFromS3Request = Message<"Ydb.Import.ImportFromS3Request"> & {
    /**
     * @generated from field: Ydb.Operations.OperationParams operation_params = 1;
     */
    operationParams?: OperationParams;
    /**
     * @generated from field: Ydb.Import.ImportFromS3Settings settings = 2;
     */
    settings?: ImportFromS3Settings;
};
/**
 * Describes the message Ydb.Import.ImportFromS3Request.
 * Use `create(ImportFromS3RequestSchema)` to create a new message.
 */
export declare const ImportFromS3RequestSchema: GenMessage<ImportFromS3Request>;
/**
 * @generated from message Ydb.Import.ImportFromS3Response
 */
export type ImportFromS3Response = Message<"Ydb.Import.ImportFromS3Response"> & {
    /**
     * operation.result = ImportFromS3Result
     * operation.metadata = ImportFromS3Metadata
     *
     * @generated from field: Ydb.Operations.Operation operation = 1;
     */
    operation?: Operation;
};
/**
 * Describes the message Ydb.Import.ImportFromS3Response.
 * Use `create(ImportFromS3ResponseSchema)` to create a new message.
 */
export declare const ImportFromS3ResponseSchema: GenMessage<ImportFromS3Response>;
/**
 * / File system (FS)
 *
 * @generated from message Ydb.Import.ImportFromFsSettings
 */
export type ImportFromFsSettings = Message<"Ydb.Import.ImportFromFsSettings"> & {
    /**
     * Base path on FS where the export is located
     * In the case of NFS, one of the directories in the path must be mounted
     * Must be an absolute path
     * Example: /mnt/exports
     * SchemaMapping file with the list of objects is read from this path
     *
     * @generated from field: string base_path = 1;
     */
    basePath: string;
    /**
     * Empty collection means import of all export objects
     *
     * @generated from field: repeated Ydb.Import.ImportFromFsSettings.Item items = 2;
     */
    items: ImportFromFsSettings_Item[];
    /**
     * Optional description
     *
     * @generated from field: string description = 3;
     */
    description: string;
    /**
     * Number of retries for failed file operations
     *
     * @generated from field: uint32 number_of_retries = 4;
     */
    numberOfRetries: number;
    /**
     * Prevent importing of ACL and owner. If true, objects are created with empty ACL
     * and their owner will be the user who started the import.
     *
     * @generated from field: bool no_acl = 5;
     */
    noAcl: boolean;
    /**
     * Skip checksum validation during import
     *
     * @generated from field: bool skip_checksum_validation = 6;
     */
    skipChecksumValidation: boolean;
    /**
     * Destination path to restore paths inside database
     * Default value is database root
     *
     * @generated from field: string destination_path = 7;
     */
    destinationPath: string;
    /**
     * Settings how data is encrypted.
     * If encryption_settings field is not specified,
     * the resulting data is considered not encrypted.
     *
     * @generated from field: Ydb.Export.EncryptionSettings encryption_settings = 8;
     */
    encryptionSettings?: EncryptionSettings;
    /**
     * Patterns (PCRE) for paths excluded from import operation.
     * - Patterns are matched against the database object names stored in the backup listing.
     * - Object is excluded from import operation if it matches any of the specified exclude regexps.
     *
     * @generated from field: repeated string exclude_regexps = 9;
     */
    excludeRegexps: string[];
};
/**
 * Describes the message Ydb.Import.ImportFromFsSettings.
 * Use `create(ImportFromFsSettingsSchema)` to create a new message.
 */
export declare const ImportFromFsSettingsSchema: GenMessage<ImportFromFsSettings>;
/**
 * @generated from message Ydb.Import.ImportFromFsSettings.Item
 */
export type ImportFromFsSettings_Item = Message<"Ydb.Import.ImportFromFsSettings.Item"> & {
    /**
     * YDB tables in FS are stored in a directory structure (see ydb_export.proto).
     * The directory contains:
     * '/data_PartNumber', where 'PartNumber' represents the index of the part, starting at zero;
     * '/scheme.pb' - object with information about scheme, indexes, etc;
     * '/permissions.pb' - object with information about ACL and owner;
     * '/metadata.json' - object with metadata about the backup.
     * The FS path can be either provided explicitly (relative to base_path)
     * Or, if the export contains the database objects list, you may specify the database object name,
     * and the FS prefix will be looked up in the database objects list by the import procedure
     *
     * @generated from field: string source_path = 1;
     */
    sourcePath: string;
    /**
     * Database path to a database object to import the item to
     * Resolved relative to the default destination_path
     * May be omitted if the item's source_path is specified, in this case will be taken equal to it
     *
     * @generated from field: string destination_path = 2;
     */
    destinationPath: string;
};
/**
 * Describes the message Ydb.Import.ImportFromFsSettings.Item.
 * Use `create(ImportFromFsSettings_ItemSchema)` to create a new message.
 */
export declare const ImportFromFsSettings_ItemSchema: GenMessage<ImportFromFsSettings_Item>;
/**
 * @generated from message Ydb.Import.ImportFromFsResult
 */
export type ImportFromFsResult = Message<"Ydb.Import.ImportFromFsResult"> & {};
/**
 * Describes the message Ydb.Import.ImportFromFsResult.
 * Use `create(ImportFromFsResultSchema)` to create a new message.
 */
export declare const ImportFromFsResultSchema: GenMessage<ImportFromFsResult>;
/**
 * @generated from message Ydb.Import.ImportFromFsMetadata
 */
export type ImportFromFsMetadata = Message<"Ydb.Import.ImportFromFsMetadata"> & {
    /**
     * @generated from field: Ydb.Import.ImportFromFsSettings settings = 1;
     */
    settings?: ImportFromFsSettings;
    /**
     * @generated from field: Ydb.Import.ImportProgress.Progress progress = 2;
     */
    progress: ImportProgress_Progress;
    /**
     * @generated from field: repeated Ydb.Import.ImportItemProgress items_progress = 3;
     */
    itemsProgress: ImportItemProgress[];
};
/**
 * Describes the message Ydb.Import.ImportFromFsMetadata.
 * Use `create(ImportFromFsMetadataSchema)` to create a new message.
 */
export declare const ImportFromFsMetadataSchema: GenMessage<ImportFromFsMetadata>;
/**
 * @generated from message Ydb.Import.ImportFromFsRequest
 */
export type ImportFromFsRequest = Message<"Ydb.Import.ImportFromFsRequest"> & {
    /**
     * @generated from field: Ydb.Operations.OperationParams operation_params = 1;
     */
    operationParams?: OperationParams;
    /**
     * @generated from field: Ydb.Import.ImportFromFsSettings settings = 2;
     */
    settings?: ImportFromFsSettings;
};
/**
 * Describes the message Ydb.Import.ImportFromFsRequest.
 * Use `create(ImportFromFsRequestSchema)` to create a new message.
 */
export declare const ImportFromFsRequestSchema: GenMessage<ImportFromFsRequest>;
/**
 * @generated from message Ydb.Import.ImportFromFsResponse
 */
export type ImportFromFsResponse = Message<"Ydb.Import.ImportFromFsResponse"> & {
    /**
     * operation.result = ImportFromFsResult
     * operation.metadata = ImportFromFsMetadata
     *
     * @generated from field: Ydb.Operations.Operation operation = 1;
     */
    operation?: Operation;
};
/**
 * Describes the message Ydb.Import.ImportFromFsResponse.
 * Use `create(ImportFromFsResponseSchema)` to create a new message.
 */
export declare const ImportFromFsResponseSchema: GenMessage<ImportFromFsResponse>;
/**
 * @generated from message Ydb.Import.ListObjectsInS3ExportSettings
 */
export type ListObjectsInS3ExportSettings = Message<"Ydb.Import.ListObjectsInS3ExportSettings"> & {
    /**
     * @generated from field: string endpoint = 1;
     */
    endpoint: string;
    /**
     * HTTPS if not specified
     *
     * @generated from field: Ydb.Import.ImportFromS3Settings.Scheme scheme = 2;
     */
    scheme: ImportFromS3Settings_Scheme;
    /**
     * @generated from field: string bucket = 3;
     */
    bucket: string;
    /**
     * @generated from field: string access_key = 4;
     */
    accessKey: string;
    /**
     * @generated from field: string secret_key = 5;
     */
    secretKey: string;
    /**
     * @generated from field: repeated Ydb.Import.ListObjectsInS3ExportSettings.Item items = 6;
     */
    items: ListObjectsInS3ExportSettings_Item[];
    /**
     * @generated from field: uint32 number_of_retries = 7;
     */
    numberOfRetries: number;
    /**
     * Region to use in requests
     *
     * @generated from field: string region = 8;
     */
    region: string;
    /**
     * disables virtual hosting style buckets aws s3 feature
     * it changes the way bucket appended to url. e.g. https//bucket_name.example.com/ vs https://example.com/bucket_name
     * details: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html
     * it is especially useful for custom s3 implementations
     *
     * @generated from field: bool disable_virtual_addressing = 9;
     */
    disableVirtualAddressing: boolean;
    /**
     * A default path prefix for all items,
     * determines that the import works with the list of objects in the SchemaMapping file.
     * Must be provided for encrypted exports.
     *
     * @generated from field: string prefix = 10;
     */
    prefix: string;
    /**
     * Settings how data is encrypted.
     * If encryption_settings field is not specified,
     * the resulting data is considered not encrypted.
     *
     * @generated from field: Ydb.Export.EncryptionSettings encryption_settings = 11;
     */
    encryptionSettings?: EncryptionSettings;
    /**
     * Patterns (PCRE) for paths excluded from import operation.
     * - Patterns are matched against the database object names stored in the backup listing.
     * - Object is excluded from import operation if it matches any of the specified exclude regexps.
     *
     * @generated from field: repeated string exclude_regexps = 12;
     */
    excludeRegexps: string[];
};
/**
 * Describes the message Ydb.Import.ListObjectsInS3ExportSettings.
 * Use `create(ListObjectsInS3ExportSettingsSchema)` to create a new message.
 */
export declare const ListObjectsInS3ExportSettingsSchema: GenMessage<ListObjectsInS3ExportSettings>;
/**
 * @generated from message Ydb.Import.ListObjectsInS3ExportSettings.Item
 */
export type ListObjectsInS3ExportSettings_Item = Message<"Ydb.Import.ListObjectsInS3ExportSettings.Item"> & {
    /**
     * Database object path
     * Recursive for directories
     *
     * @generated from field: string path = 1;
     */
    path: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInS3ExportSettings.Item.
 * Use `create(ListObjectsInS3ExportSettings_ItemSchema)` to create a new message.
 */
export declare const ListObjectsInS3ExportSettings_ItemSchema: GenMessage<ListObjectsInS3ExportSettings_Item>;
/**
 * @generated from message Ydb.Import.ListObjectsInS3ExportResult
 */
export type ListObjectsInS3ExportResult = Message<"Ydb.Import.ListObjectsInS3ExportResult"> & {
    /**
     * @generated from field: repeated Ydb.Import.ListObjectsInS3ExportResult.Item items = 1;
     */
    items: ListObjectsInS3ExportResult_Item[];
    /**
     * This token allows you to get the next page of results for ListObjectsInS3Export requests,
     * if the number of results is larger than `page_size` specified in the request.
     * To get the next page, specify the value of `next_page_token` as a value for
     * the `page_token` parameter in the next ListObjectsInS3Export request. Subsequent ListObjectsInS3Export
     * requests will have their own `next_page_token` to continue paging through the results.
     *
     * @generated from field: string next_page_token = 2;
     */
    nextPageToken: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInS3ExportResult.
 * Use `create(ListObjectsInS3ExportResultSchema)` to create a new message.
 */
export declare const ListObjectsInS3ExportResultSchema: GenMessage<ListObjectsInS3ExportResult>;
/**
 * YDB database objects in S3 are stored in one or more S3 objects (see ydb_export.proto).
 * The S3 object name begins with a prefix, followed by:
 * '/data_PartNumber', where 'PartNumber' represents the index of the part, starting at zero;
 * '/scheme.pb' - object with information about scheme, indexes, etc;
 * '/permissions.pb' - object with information about ACL and owner.
 *
 * @generated from message Ydb.Import.ListObjectsInS3ExportResult.Item
 */
export type ListObjectsInS3ExportResult_Item = Message<"Ydb.Import.ListObjectsInS3ExportResult.Item"> & {
    /**
     * S3 object prefix
     *
     * @generated from field: string prefix = 1;
     */
    prefix: string;
    /**
     * Database object path
     *
     * @generated from field: string path = 2;
     */
    path: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInS3ExportResult.Item.
 * Use `create(ListObjectsInS3ExportResult_ItemSchema)` to create a new message.
 */
export declare const ListObjectsInS3ExportResult_ItemSchema: GenMessage<ListObjectsInS3ExportResult_Item>;
/**
 * @generated from message Ydb.Import.ListObjectsInS3ExportRequest
 */
export type ListObjectsInS3ExportRequest = Message<"Ydb.Import.ListObjectsInS3ExportRequest"> & {
    /**
     * @generated from field: Ydb.Operations.OperationParams operation_params = 1;
     */
    operationParams?: OperationParams;
    /**
     * @generated from field: Ydb.Import.ListObjectsInS3ExportSettings settings = 2;
     */
    settings?: ListObjectsInS3ExportSettings;
    /**
     * The maximum number of results per page that should be returned. If the number of available
     * results is larger than `page_size`, the service returns a `next_page_token` that can be used
     * to get the next page of results in subsequent ListObjectsInS3Export requests.
     * 0 means that server returns all objects.
     *
     * @generated from field: int64 page_size = 3;
     */
    pageSize: bigint;
    /**
     * Page token. Set `page_token` to the `next_page_token` returned by a previous ListObjectsInS3Export
     * request to get the next page of results.
     *
     * @generated from field: string page_token = 4;
     */
    pageToken: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInS3ExportRequest.
 * Use `create(ListObjectsInS3ExportRequestSchema)` to create a new message.
 */
export declare const ListObjectsInS3ExportRequestSchema: GenMessage<ListObjectsInS3ExportRequest>;
/**
 * @generated from message Ydb.Import.ListObjectsInS3ExportResponse
 */
export type ListObjectsInS3ExportResponse = Message<"Ydb.Import.ListObjectsInS3ExportResponse"> & {
    /**
     * operation.result = ListObjectsInS3ExportResult
     *
     * @generated from field: Ydb.Operations.Operation operation = 1;
     */
    operation?: Operation;
};
/**
 * Describes the message Ydb.Import.ListObjectsInS3ExportResponse.
 * Use `create(ListObjectsInS3ExportResponseSchema)` to create a new message.
 */
export declare const ListObjectsInS3ExportResponseSchema: GenMessage<ListObjectsInS3ExportResponse>;
/**
 * @generated from message Ydb.Import.ListObjectsInFsExportSettings
 */
export type ListObjectsInFsExportSettings = Message<"Ydb.Import.ListObjectsInFsExportSettings"> & {
    /**
     * @generated from field: string base_path = 1;
     */
    basePath: string;
    /**
     * @generated from field: repeated Ydb.Import.ListObjectsInFsExportSettings.Item items = 2;
     */
    items: ListObjectsInFsExportSettings_Item[];
    /**
     * @generated from field: uint32 number_of_retries = 3;
     */
    numberOfRetries: number;
    /**
     * Settings how data is encrypted.
     * If encryption_settings field is not specified,
     * the resulting data is considered not encrypted.
     *
     * @generated from field: Ydb.Export.EncryptionSettings encryption_settings = 4;
     */
    encryptionSettings?: EncryptionSettings;
    /**
     * Patterns (PCRE) for paths excluded from import operation.
     * - Patterns are matched against the database object names stored in the backup listing.
     * - Object is excluded from import operation if it matches any of the specified exclude regexps.
     *
     * @generated from field: repeated string exclude_regexps = 5;
     */
    excludeRegexps: string[];
};
/**
 * Describes the message Ydb.Import.ListObjectsInFsExportSettings.
 * Use `create(ListObjectsInFsExportSettingsSchema)` to create a new message.
 */
export declare const ListObjectsInFsExportSettingsSchema: GenMessage<ListObjectsInFsExportSettings>;
/**
 * @generated from message Ydb.Import.ListObjectsInFsExportSettings.Item
 */
export type ListObjectsInFsExportSettings_Item = Message<"Ydb.Import.ListObjectsInFsExportSettings.Item"> & {
    /**
     * Database object path
     * Recursive for directories
     *
     * @generated from field: string path = 1;
     */
    path: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInFsExportSettings.Item.
 * Use `create(ListObjectsInFsExportSettings_ItemSchema)` to create a new message.
 */
export declare const ListObjectsInFsExportSettings_ItemSchema: GenMessage<ListObjectsInFsExportSettings_Item>;
/**
 * @generated from message Ydb.Import.ListObjectsInFsExportResult
 */
export type ListObjectsInFsExportResult = Message<"Ydb.Import.ListObjectsInFsExportResult"> & {
    /**
     * @generated from field: repeated Ydb.Import.ListObjectsInFsExportResult.Item items = 1;
     */
    items: ListObjectsInFsExportResult_Item[];
    /**
     * This token allows you to get the next page of results for ListObjectsInFsExport requests,
     * if the number of results is larger than `page_size` specified in the request.
     * To get the next page, specify the value of `next_page_token` as a value for
     * the `page_token` parameter in the next ListObjectsInFsExport request. Subsequent ListObjectsInFsExport
     * requests will have their own `next_page_token` to continue paging through the results.
     *
     * @generated from field: string next_page_token = 2;
     */
    nextPageToken: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInFsExportResult.
 * Use `create(ListObjectsInFsExportResultSchema)` to create a new message.
 */
export declare const ListObjectsInFsExportResultSchema: GenMessage<ListObjectsInFsExportResult>;
/**
 * @generated from message Ydb.Import.ListObjectsInFsExportResult.Item
 */
export type ListObjectsInFsExportResult_Item = Message<"Ydb.Import.ListObjectsInFsExportResult.Item"> & {
    /**
     * YDB database objects in S3 are stored in one or more S3 objects (see ydb_export.proto).
     * The S3 object name begins with a prefix, followed by:
     * '/data_PartNumber', where 'PartNumber' represents the index of the part, starting at zero;
     * '/scheme.pb' - object with information about scheme, indexes, etc;
     * '/permissions.pb' - object with information about ACL and owner;
     * '/metadata.json' - object with metadata about the backup.
     *
     * @generated from field: string fs_path = 1;
     */
    fsPath: string;
    /**
     * @generated from field: string db_path = 2;
     */
    dbPath: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInFsExportResult.Item.
 * Use `create(ListObjectsInFsExportResult_ItemSchema)` to create a new message.
 */
export declare const ListObjectsInFsExportResult_ItemSchema: GenMessage<ListObjectsInFsExportResult_Item>;
/**
 * @generated from message Ydb.Import.ListObjectsInFsExportRequest
 */
export type ListObjectsInFsExportRequest = Message<"Ydb.Import.ListObjectsInFsExportRequest"> & {
    /**
     * @generated from field: Ydb.Operations.OperationParams operation_params = 1;
     */
    operationParams?: OperationParams;
    /**
     * @generated from field: Ydb.Import.ListObjectsInFsExportSettings settings = 2;
     */
    settings?: ListObjectsInFsExportSettings;
    /**
     * The maximum number of results per page that should be returned. If the number of available
     * results is larger than `page_size`, the service returns a `next_page_token` that can be used
     * to get the next page of results in subsequent ListObjectsInFsExport requests.
     * 0 means that server returns all objects.
     *
     * @generated from field: int64 page_size = 3;
     */
    pageSize: bigint;
    /**
     * Page token. Set `page_token` to the `next_page_token` returned by a previous ListObjectsInFsExport
     * request to get the next page of results.
     *
     * @generated from field: string page_token = 4;
     */
    pageToken: string;
};
/**
 * Describes the message Ydb.Import.ListObjectsInFsExportRequest.
 * Use `create(ListObjectsInFsExportRequestSchema)` to create a new message.
 */
export declare const ListObjectsInFsExportRequestSchema: GenMessage<ListObjectsInFsExportRequest>;
/**
 * @generated from message Ydb.Import.ListObjectsInFsExportResponse
 */
export type ListObjectsInFsExportResponse = Message<"Ydb.Import.ListObjectsInFsExportResponse"> & {
    /**
     * operation.result = ListObjectsInFsExportResult
     *
     * @generated from field: Ydb.Operations.Operation operation = 1;
     */
    operation?: Operation;
};
/**
 * Describes the message Ydb.Import.ListObjectsInFsExportResponse.
 * Use `create(ListObjectsInFsExportResponseSchema)` to create a new message.
 */
export declare const ListObjectsInFsExportResponseSchema: GenMessage<ListObjectsInFsExportResponse>;
/**
 * / Data
 *
 * @generated from message Ydb.Import.YdbDumpFormat
 */
export type YdbDumpFormat = Message<"Ydb.Import.YdbDumpFormat"> & {
    /**
     * @generated from field: repeated string columns = 1;
     */
    columns: string[];
};
/**
 * Describes the message Ydb.Import.YdbDumpFormat.
 * Use `create(YdbDumpFormatSchema)` to create a new message.
 */
export declare const YdbDumpFormatSchema: GenMessage<YdbDumpFormat>;
/**
 * @generated from message Ydb.Import.ImportDataResult
 */
export type ImportDataResult = Message<"Ydb.Import.ImportDataResult"> & {};
/**
 * Describes the message Ydb.Import.ImportDataResult.
 * Use `create(ImportDataResultSchema)` to create a new message.
 */
export declare const ImportDataResultSchema: GenMessage<ImportDataResult>;
/**
 * @generated from message Ydb.Import.ImportDataRequest
 */
export type ImportDataRequest = Message<"Ydb.Import.ImportDataRequest"> & {
    /**
     * @generated from field: Ydb.Operations.OperationParams operation_params = 1;
     */
    operationParams?: OperationParams;
    /**
     * Full path to table
     *
     * @generated from field: string path = 2;
     */
    path: string;
    /**
     * Data serialized in the selected format. Restrictions:
     * - sorted by primary key;
     * - all keys must be from the same partition;
     * - table has no global secondary indexes;
     * - size of serialized data is limited to 16 MB.
     *
     * @generated from field: bytes data = 3;
     */
    data: Uint8Array;
    /**
     * @generated from oneof Ydb.Import.ImportDataRequest.format
     */
    format: {
        /**
         * Result of `ydb tools dump`
         *
         * @generated from field: Ydb.Import.YdbDumpFormat ydb_dump = 4;
         */
        value: YdbDumpFormat;
        case: "ydbDump";
    } | {
        case: undefined;
        value?: undefined;
    };
};
/**
 * Describes the message Ydb.Import.ImportDataRequest.
 * Use `create(ImportDataRequestSchema)` to create a new message.
 */
export declare const ImportDataRequestSchema: GenMessage<ImportDataRequest>;
/**
 * @generated from message Ydb.Import.ImportDataResponse
 */
export type ImportDataResponse = Message<"Ydb.Import.ImportDataResponse"> & {
    /**
     * operation.result = ImportDataResult
     *
     * @generated from field: Ydb.Operations.Operation operation = 1;
     */
    operation?: Operation;
};
/**
 * Describes the message Ydb.Import.ImportDataResponse.
 * Use `create(ImportDataResponseSchema)` to create a new message.
 */
export declare const ImportDataResponseSchema: GenMessage<ImportDataResponse>;
//# sourceMappingURL=ydb_import_pb.d.ts.map