@firestore-emulator/proto
Version:
Generated Firestore Protobufs For Firestore Emulator
446 lines • 19.3 kB
TypeScript
import * as dependency_2 from "./index";
import * as dependency_3 from "./../../../protobuf/timestamp";
import * as pb_1 from "google-protobuf";
export declare enum OperationState {
OPERATION_STATE_UNSPECIFIED = 0,
INITIALIZING = 1,
PROCESSING = 2,
CANCELLING = 3,
FINALIZING = 4,
SUCCESSFUL = 5,
FAILED = 6,
CANCELLED = 7
}
export declare class IndexOperationMetadata extends pb_1.Message {
#private;
constructor(data?: any[] | {
start_time?: dependency_3.Timestamp;
end_time?: dependency_3.Timestamp;
index?: string;
state?: OperationState;
progress_documents?: Progress;
progress_bytes?: Progress;
});
get start_time(): dependency_3.Timestamp;
set start_time(value: dependency_3.Timestamp);
get has_start_time(): boolean;
get end_time(): dependency_3.Timestamp;
set end_time(value: dependency_3.Timestamp);
get has_end_time(): boolean;
get index(): string;
set index(value: string);
get state(): OperationState;
set state(value: OperationState);
get progress_documents(): Progress;
set progress_documents(value: Progress);
get has_progress_documents(): boolean;
get progress_bytes(): Progress;
set progress_bytes(value: Progress);
get has_progress_bytes(): boolean;
static fromObject(data: {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
index?: string;
state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
}): IndexOperationMetadata;
toObject(): {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
index?: string;
state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): IndexOperationMetadata;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): IndexOperationMetadata;
}
export declare class FieldOperationMetadata extends pb_1.Message {
#private;
constructor(data?: any[] | {
start_time?: dependency_3.Timestamp;
end_time?: dependency_3.Timestamp;
field?: string;
index_config_deltas?: FieldOperationMetadataIndexConfigDelta[];
state?: OperationState;
progress_documents?: Progress;
progress_bytes?: Progress;
ttl_config_delta?: FieldOperationMetadataTtlConfigDelta;
});
get start_time(): dependency_3.Timestamp;
set start_time(value: dependency_3.Timestamp);
get has_start_time(): boolean;
get end_time(): dependency_3.Timestamp;
set end_time(value: dependency_3.Timestamp);
get has_end_time(): boolean;
get field(): string;
set field(value: string);
get index_config_deltas(): FieldOperationMetadataIndexConfigDelta[];
set index_config_deltas(value: FieldOperationMetadataIndexConfigDelta[]);
get state(): OperationState;
set state(value: OperationState);
get progress_documents(): Progress;
set progress_documents(value: Progress);
get has_progress_documents(): boolean;
get progress_bytes(): Progress;
set progress_bytes(value: Progress);
get has_progress_bytes(): boolean;
get ttl_config_delta(): FieldOperationMetadataTtlConfigDelta;
set ttl_config_delta(value: FieldOperationMetadataTtlConfigDelta);
get has_ttl_config_delta(): boolean;
static fromObject(data: {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
field?: string;
index_config_deltas?: ReturnType<typeof FieldOperationMetadataIndexConfigDelta.prototype.toObject>[];
state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
ttl_config_delta?: ReturnType<typeof FieldOperationMetadataTtlConfigDelta.prototype.toObject>;
}): FieldOperationMetadata;
toObject(): {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
field?: string;
index_config_deltas?: ReturnType<typeof FieldOperationMetadataIndexConfigDelta.prototype.toObject>[];
state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
ttl_config_delta?: ReturnType<typeof FieldOperationMetadataTtlConfigDelta.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): FieldOperationMetadata;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): FieldOperationMetadata;
}
export declare class FieldOperationMetadataIndexConfigDelta extends pb_1.Message {
#private;
constructor(data?: any[] | {
change_type?: FieldOperationMetadataIndexConfigDeltaChangeType;
index?: dependency_2.Index;
});
get change_type(): FieldOperationMetadataIndexConfigDeltaChangeType;
set change_type(value: FieldOperationMetadataIndexConfigDeltaChangeType);
get index(): dependency_2.Index;
set index(value: dependency_2.Index);
get has_index(): boolean;
static fromObject(data: {
change_type?: FieldOperationMetadataIndexConfigDeltaChangeType;
index?: ReturnType<typeof dependency_2.Index.prototype.toObject>;
}): FieldOperationMetadataIndexConfigDelta;
toObject(): {
change_type?: FieldOperationMetadataIndexConfigDeltaChangeType;
index?: ReturnType<typeof dependency_2.Index.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): FieldOperationMetadataIndexConfigDelta;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): FieldOperationMetadataIndexConfigDelta;
}
export declare enum FieldOperationMetadataIndexConfigDeltaChangeType {
CHANGE_TYPE_UNSPECIFIED = 0,
ADD = 1,
REMOVE = 2
}
export declare class FieldOperationMetadataTtlConfigDelta extends pb_1.Message {
#private;
constructor(data?: any[] | {
change_type?: FieldOperationMetadataTtlConfigDeltaChangeType;
});
get change_type(): FieldOperationMetadataTtlConfigDeltaChangeType;
set change_type(value: FieldOperationMetadataTtlConfigDeltaChangeType);
static fromObject(data: {
change_type?: FieldOperationMetadataTtlConfigDeltaChangeType;
}): FieldOperationMetadataTtlConfigDelta;
toObject(): {
change_type?: FieldOperationMetadataTtlConfigDeltaChangeType;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): FieldOperationMetadataTtlConfigDelta;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): FieldOperationMetadataTtlConfigDelta;
}
export declare enum FieldOperationMetadataTtlConfigDeltaChangeType {
CHANGE_TYPE_UNSPECIFIED = 0,
ADD = 1,
REMOVE = 2
}
export declare class ExportDocumentsMetadata extends pb_1.Message {
#private;
constructor(data?: any[] | {
start_time?: dependency_3.Timestamp;
end_time?: dependency_3.Timestamp;
operation_state?: OperationState;
progress_documents?: Progress;
progress_bytes?: Progress;
collection_ids?: string[];
output_uri_prefix?: string;
namespace_ids?: string[];
snapshot_time?: dependency_3.Timestamp;
});
get start_time(): dependency_3.Timestamp;
set start_time(value: dependency_3.Timestamp);
get has_start_time(): boolean;
get end_time(): dependency_3.Timestamp;
set end_time(value: dependency_3.Timestamp);
get has_end_time(): boolean;
get operation_state(): OperationState;
set operation_state(value: OperationState);
get progress_documents(): Progress;
set progress_documents(value: Progress);
get has_progress_documents(): boolean;
get progress_bytes(): Progress;
set progress_bytes(value: Progress);
get has_progress_bytes(): boolean;
get collection_ids(): string[];
set collection_ids(value: string[]);
get output_uri_prefix(): string;
set output_uri_prefix(value: string);
get namespace_ids(): string[];
set namespace_ids(value: string[]);
get snapshot_time(): dependency_3.Timestamp;
set snapshot_time(value: dependency_3.Timestamp);
get has_snapshot_time(): boolean;
static fromObject(data: {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
collection_ids?: string[];
output_uri_prefix?: string;
namespace_ids?: string[];
snapshot_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
}): ExportDocumentsMetadata;
toObject(): {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
collection_ids?: string[];
output_uri_prefix?: string;
namespace_ids?: string[];
snapshot_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ExportDocumentsMetadata;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ExportDocumentsMetadata;
}
export declare class ImportDocumentsMetadata extends pb_1.Message {
#private;
constructor(data?: any[] | {
start_time?: dependency_3.Timestamp;
end_time?: dependency_3.Timestamp;
operation_state?: OperationState;
progress_documents?: Progress;
progress_bytes?: Progress;
collection_ids?: string[];
input_uri_prefix?: string;
namespace_ids?: string[];
});
get start_time(): dependency_3.Timestamp;
set start_time(value: dependency_3.Timestamp);
get has_start_time(): boolean;
get end_time(): dependency_3.Timestamp;
set end_time(value: dependency_3.Timestamp);
get has_end_time(): boolean;
get operation_state(): OperationState;
set operation_state(value: OperationState);
get progress_documents(): Progress;
set progress_documents(value: Progress);
get has_progress_documents(): boolean;
get progress_bytes(): Progress;
set progress_bytes(value: Progress);
get has_progress_bytes(): boolean;
get collection_ids(): string[];
set collection_ids(value: string[]);
get input_uri_prefix(): string;
set input_uri_prefix(value: string);
get namespace_ids(): string[];
set namespace_ids(value: string[]);
static fromObject(data: {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
collection_ids?: string[];
input_uri_prefix?: string;
namespace_ids?: string[];
}): ImportDocumentsMetadata;
toObject(): {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
collection_ids?: string[];
input_uri_prefix?: string;
namespace_ids?: string[];
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ImportDocumentsMetadata;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ImportDocumentsMetadata;
}
export declare class BulkDeleteDocumentsMetadata extends pb_1.Message {
#private;
constructor(data?: any[] | {
start_time?: dependency_3.Timestamp;
end_time?: dependency_3.Timestamp;
operation_state?: OperationState;
progress_documents?: Progress;
progress_bytes?: Progress;
collection_ids?: string[];
namespace_ids?: string[];
snapshot_time?: dependency_3.Timestamp;
});
get start_time(): dependency_3.Timestamp;
set start_time(value: dependency_3.Timestamp);
get has_start_time(): boolean;
get end_time(): dependency_3.Timestamp;
set end_time(value: dependency_3.Timestamp);
get has_end_time(): boolean;
get operation_state(): OperationState;
set operation_state(value: OperationState);
get progress_documents(): Progress;
set progress_documents(value: Progress);
get has_progress_documents(): boolean;
get progress_bytes(): Progress;
set progress_bytes(value: Progress);
get has_progress_bytes(): boolean;
get collection_ids(): string[];
set collection_ids(value: string[]);
get namespace_ids(): string[];
set namespace_ids(value: string[]);
get snapshot_time(): dependency_3.Timestamp;
set snapshot_time(value: dependency_3.Timestamp);
get has_snapshot_time(): boolean;
static fromObject(data: {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
collection_ids?: string[];
namespace_ids?: string[];
snapshot_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
}): BulkDeleteDocumentsMetadata;
toObject(): {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
progress_documents?: ReturnType<typeof Progress.prototype.toObject>;
progress_bytes?: ReturnType<typeof Progress.prototype.toObject>;
collection_ids?: string[];
namespace_ids?: string[];
snapshot_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BulkDeleteDocumentsMetadata;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BulkDeleteDocumentsMetadata;
}
export declare class ExportDocumentsResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
output_uri_prefix?: string;
});
get output_uri_prefix(): string;
set output_uri_prefix(value: string);
static fromObject(data: {
output_uri_prefix?: string;
}): ExportDocumentsResponse;
toObject(): {
output_uri_prefix?: string;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ExportDocumentsResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ExportDocumentsResponse;
}
export declare class RestoreDatabaseMetadata extends pb_1.Message {
#private;
constructor(data?: any[] | {
start_time?: dependency_3.Timestamp;
end_time?: dependency_3.Timestamp;
operation_state?: OperationState;
database?: string;
backup?: string;
progress_percentage?: Progress;
});
get start_time(): dependency_3.Timestamp;
set start_time(value: dependency_3.Timestamp);
get has_start_time(): boolean;
get end_time(): dependency_3.Timestamp;
set end_time(value: dependency_3.Timestamp);
get has_end_time(): boolean;
get operation_state(): OperationState;
set operation_state(value: OperationState);
get database(): string;
set database(value: string);
get backup(): string;
set backup(value: string);
get progress_percentage(): Progress;
set progress_percentage(value: Progress);
get has_progress_percentage(): boolean;
static fromObject(data: {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
database?: string;
backup?: string;
progress_percentage?: ReturnType<typeof Progress.prototype.toObject>;
}): RestoreDatabaseMetadata;
toObject(): {
start_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
end_time?: ReturnType<typeof dependency_3.Timestamp.prototype.toObject>;
operation_state?: OperationState;
database?: string;
backup?: string;
progress_percentage?: ReturnType<typeof Progress.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): RestoreDatabaseMetadata;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): RestoreDatabaseMetadata;
}
export declare class Progress extends pb_1.Message {
#private;
constructor(data?: any[] | {
estimated_work?: number;
completed_work?: number;
});
get estimated_work(): number;
set estimated_work(value: number);
get completed_work(): number;
set completed_work(value: number);
static fromObject(data: {
estimated_work?: number;
completed_work?: number;
}): Progress;
toObject(): {
estimated_work?: number;
completed_work?: number;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): Progress;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): Progress;
}
//# sourceMappingURL=operation.d.ts.map