@firestore-emulator/proto
Version:
Generated Firestore Protobufs For Firestore Emulator
1,240 lines (1,239 loc) • 61.3 kB
TypeScript
import * as dependency_4 from "./aggregation_result";
import * as dependency_5 from "./common";
import * as dependency_6 from "./document";
import * as dependency_7 from "./query";
import * as dependency_8 from "./query_profile";
import * as dependency_9 from "./write";
import * as dependency_10 from "./../../protobuf/empty";
import * as dependency_11 from "./../../protobuf/timestamp";
import * as dependency_12 from "./../../protobuf/wrappers";
import * as dependency_13 from "./../../rpc/status";
import * as pb_1 from "google-protobuf";
import * as grpc_1 from "@grpc/grpc-js";
export declare class GetDocumentRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
name?: string;
mask?: dependency_5.DocumentMask;
} & (({
transaction?: Uint8Array;
read_time?: never;
} | {
transaction?: never;
read_time?: dependency_11.Timestamp;
}))));
get name(): string;
set name(value: string);
get mask(): dependency_5.DocumentMask;
set mask(value: dependency_5.DocumentMask);
get has_mask(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get has_transaction(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get consistency_selector(): "none" | "read_time" | "transaction";
static fromObject(data: {
name?: string;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): GetDocumentRequest;
toObject(): {
name?: string;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): GetDocumentRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): GetDocumentRequest;
}
export declare class ListDocumentsRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
parent?: string;
collection_id?: string;
page_size?: number;
page_token?: string;
order_by?: string;
mask?: dependency_5.DocumentMask;
show_missing?: boolean;
} & (({
transaction?: Uint8Array;
read_time?: never;
} | {
transaction?: never;
read_time?: dependency_11.Timestamp;
}))));
get parent(): string;
set parent(value: string);
get collection_id(): string;
set collection_id(value: string);
get page_size(): number;
set page_size(value: number);
get page_token(): string;
set page_token(value: string);
get order_by(): string;
set order_by(value: string);
get mask(): dependency_5.DocumentMask;
set mask(value: dependency_5.DocumentMask);
get has_mask(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get has_transaction(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get show_missing(): boolean;
set show_missing(value: boolean);
get consistency_selector(): "none" | "read_time" | "transaction";
static fromObject(data: {
parent?: string;
collection_id?: string;
page_size?: number;
page_token?: string;
order_by?: string;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
show_missing?: boolean;
}): ListDocumentsRequest;
toObject(): {
parent?: string;
collection_id?: string;
page_size?: number;
page_token?: string;
order_by?: string;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
show_missing?: boolean;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ListDocumentsRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ListDocumentsRequest;
}
export declare class ListDocumentsResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
documents?: dependency_6.Document[];
next_page_token?: string;
});
get documents(): dependency_6.Document[];
set documents(value: dependency_6.Document[]);
get next_page_token(): string;
set next_page_token(value: string);
static fromObject(data: {
documents?: ReturnType<typeof dependency_6.Document.prototype.toObject>[];
next_page_token?: string;
}): ListDocumentsResponse;
toObject(): {
documents?: ReturnType<typeof dependency_6.Document.prototype.toObject>[];
next_page_token?: string;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ListDocumentsResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ListDocumentsResponse;
}
export declare class CreateDocumentRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
parent?: string;
collection_id?: string;
document_id?: string;
document?: dependency_6.Document;
mask?: dependency_5.DocumentMask;
});
get parent(): string;
set parent(value: string);
get collection_id(): string;
set collection_id(value: string);
get document_id(): string;
set document_id(value: string);
get document(): dependency_6.Document;
set document(value: dependency_6.Document);
get has_document(): boolean;
get mask(): dependency_5.DocumentMask;
set mask(value: dependency_5.DocumentMask);
get has_mask(): boolean;
static fromObject(data: {
parent?: string;
collection_id?: string;
document_id?: string;
document?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
}): CreateDocumentRequest;
toObject(): {
parent?: string;
collection_id?: string;
document_id?: string;
document?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): CreateDocumentRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): CreateDocumentRequest;
}
export declare class UpdateDocumentRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
document?: dependency_6.Document;
update_mask?: dependency_5.DocumentMask;
mask?: dependency_5.DocumentMask;
current_document?: dependency_5.Precondition;
});
get document(): dependency_6.Document;
set document(value: dependency_6.Document);
get has_document(): boolean;
get update_mask(): dependency_5.DocumentMask;
set update_mask(value: dependency_5.DocumentMask);
get has_update_mask(): boolean;
get mask(): dependency_5.DocumentMask;
set mask(value: dependency_5.DocumentMask);
get has_mask(): boolean;
get current_document(): dependency_5.Precondition;
set current_document(value: dependency_5.Precondition);
get has_current_document(): boolean;
static fromObject(data: {
document?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
update_mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
current_document?: ReturnType<typeof dependency_5.Precondition.prototype.toObject>;
}): UpdateDocumentRequest;
toObject(): {
document?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
update_mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
current_document?: ReturnType<typeof dependency_5.Precondition.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): UpdateDocumentRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): UpdateDocumentRequest;
}
export declare class DeleteDocumentRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
name?: string;
current_document?: dependency_5.Precondition;
});
get name(): string;
set name(value: string);
get current_document(): dependency_5.Precondition;
set current_document(value: dependency_5.Precondition);
get has_current_document(): boolean;
static fromObject(data: {
name?: string;
current_document?: ReturnType<typeof dependency_5.Precondition.prototype.toObject>;
}): DeleteDocumentRequest;
toObject(): {
name?: string;
current_document?: ReturnType<typeof dependency_5.Precondition.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): DeleteDocumentRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): DeleteDocumentRequest;
}
export declare class BatchGetDocumentsRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
database?: string;
documents?: string[];
mask?: dependency_5.DocumentMask;
} & (({
transaction?: Uint8Array;
new_transaction?: never;
read_time?: never;
} | {
transaction?: never;
new_transaction?: dependency_5.TransactionOptions;
read_time?: never;
} | {
transaction?: never;
new_transaction?: never;
read_time?: dependency_11.Timestamp;
}))));
get database(): string;
set database(value: string);
get documents(): string[];
set documents(value: string[]);
get mask(): dependency_5.DocumentMask;
set mask(value: dependency_5.DocumentMask);
get has_mask(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get has_transaction(): boolean;
get new_transaction(): dependency_5.TransactionOptions;
set new_transaction(value: dependency_5.TransactionOptions);
get has_new_transaction(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get consistency_selector(): "none" | "read_time" | "transaction" | "new_transaction";
static fromObject(data: {
database?: string;
documents?: string[];
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
transaction?: Uint8Array;
new_transaction?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): BatchGetDocumentsRequest;
toObject(): {
database?: string;
documents?: string[];
mask?: ReturnType<typeof dependency_5.DocumentMask.prototype.toObject>;
transaction?: Uint8Array;
new_transaction?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BatchGetDocumentsRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BatchGetDocumentsRequest;
}
export declare class BatchGetDocumentsResponse extends pb_1.Message {
#private;
constructor(data?: any[] | ({
transaction?: Uint8Array;
read_time?: dependency_11.Timestamp;
} & (({
found?: dependency_6.Document;
missing?: never;
} | {
found?: never;
missing?: string;
}))));
get found(): dependency_6.Document;
set found(value: dependency_6.Document);
get has_found(): boolean;
get missing(): string;
set missing(value: string);
get has_missing(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get result(): "none" | "found" | "missing";
static fromObject(data: {
found?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
missing?: string;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): BatchGetDocumentsResponse;
toObject(): {
found?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
missing?: string;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BatchGetDocumentsResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BatchGetDocumentsResponse;
}
export declare class BeginTransactionRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
database?: string;
options?: dependency_5.TransactionOptions;
});
get database(): string;
set database(value: string);
get options(): dependency_5.TransactionOptions;
set options(value: dependency_5.TransactionOptions);
get has_options(): boolean;
static fromObject(data: {
database?: string;
options?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
}): BeginTransactionRequest;
toObject(): {
database?: string;
options?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BeginTransactionRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BeginTransactionRequest;
}
export declare class BeginTransactionResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
transaction?: Uint8Array;
});
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
static fromObject(data: {
transaction?: Uint8Array;
}): BeginTransactionResponse;
toObject(): {
transaction?: Uint8Array;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BeginTransactionResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BeginTransactionResponse;
}
export declare class CommitRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
database?: string;
writes?: dependency_9.Write[];
transaction?: Uint8Array;
});
get database(): string;
set database(value: string);
get writes(): dependency_9.Write[];
set writes(value: dependency_9.Write[]);
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
static fromObject(data: {
database?: string;
writes?: ReturnType<typeof dependency_9.Write.prototype.toObject>[];
transaction?: Uint8Array;
}): CommitRequest;
toObject(): {
database?: string;
writes?: ReturnType<typeof dependency_9.Write.prototype.toObject>[];
transaction?: Uint8Array;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): CommitRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): CommitRequest;
}
export declare class CommitResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
write_results?: dependency_9.WriteResult[];
commit_time?: dependency_11.Timestamp;
});
get write_results(): dependency_9.WriteResult[];
set write_results(value: dependency_9.WriteResult[]);
get commit_time(): dependency_11.Timestamp;
set commit_time(value: dependency_11.Timestamp);
get has_commit_time(): boolean;
static fromObject(data: {
write_results?: ReturnType<typeof dependency_9.WriteResult.prototype.toObject>[];
commit_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): CommitResponse;
toObject(): {
write_results?: ReturnType<typeof dependency_9.WriteResult.prototype.toObject>[];
commit_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): CommitResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): CommitResponse;
}
export declare class RollbackRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
database?: string;
transaction?: Uint8Array;
});
get database(): string;
set database(value: string);
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
static fromObject(data: {
database?: string;
transaction?: Uint8Array;
}): RollbackRequest;
toObject(): {
database?: string;
transaction?: Uint8Array;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): RollbackRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): RollbackRequest;
}
export declare class RunQueryRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
parent?: string;
explain_options?: dependency_8.ExplainOptions;
} & (({
structured_query?: dependency_7.StructuredQuery;
}) | ({
transaction?: Uint8Array;
new_transaction?: never;
read_time?: never;
} | {
transaction?: never;
new_transaction?: dependency_5.TransactionOptions;
read_time?: never;
} | {
transaction?: never;
new_transaction?: never;
read_time?: dependency_11.Timestamp;
}))));
get parent(): string;
set parent(value: string);
get structured_query(): dependency_7.StructuredQuery;
set structured_query(value: dependency_7.StructuredQuery);
get has_structured_query(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get has_transaction(): boolean;
get new_transaction(): dependency_5.TransactionOptions;
set new_transaction(value: dependency_5.TransactionOptions);
get has_new_transaction(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get explain_options(): dependency_8.ExplainOptions;
set explain_options(value: dependency_8.ExplainOptions);
get has_explain_options(): boolean;
get query_type(): "none" | "structured_query";
get consistency_selector(): "none" | "read_time" | "transaction" | "new_transaction";
static fromObject(data: {
parent?: string;
structured_query?: ReturnType<typeof dependency_7.StructuredQuery.prototype.toObject>;
transaction?: Uint8Array;
new_transaction?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
explain_options?: ReturnType<typeof dependency_8.ExplainOptions.prototype.toObject>;
}): RunQueryRequest;
toObject(): {
parent?: string;
structured_query?: ReturnType<typeof dependency_7.StructuredQuery.prototype.toObject>;
transaction?: Uint8Array;
new_transaction?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
explain_options?: ReturnType<typeof dependency_8.ExplainOptions.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): RunQueryRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): RunQueryRequest;
}
export declare class RunQueryResponse extends pb_1.Message {
#private;
constructor(data?: any[] | ({
transaction?: Uint8Array;
document?: dependency_6.Document;
read_time?: dependency_11.Timestamp;
skipped_results?: number;
explain_metrics?: dependency_8.ExplainMetrics;
} & (({
done?: boolean;
}))));
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get document(): dependency_6.Document;
set document(value: dependency_6.Document);
get has_document(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get skipped_results(): number;
set skipped_results(value: number);
get done(): boolean;
set done(value: boolean);
get has_done(): boolean;
get explain_metrics(): dependency_8.ExplainMetrics;
set explain_metrics(value: dependency_8.ExplainMetrics);
get has_explain_metrics(): boolean;
get continuation_selector(): "none" | "done";
static fromObject(data: {
transaction?: Uint8Array;
document?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
skipped_results?: number;
done?: boolean;
explain_metrics?: ReturnType<typeof dependency_8.ExplainMetrics.prototype.toObject>;
}): RunQueryResponse;
toObject(): {
transaction?: Uint8Array;
document?: ReturnType<typeof dependency_6.Document.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
skipped_results?: number;
done?: boolean;
explain_metrics?: ReturnType<typeof dependency_8.ExplainMetrics.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): RunQueryResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): RunQueryResponse;
}
export declare class RunAggregationQueryRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
parent?: string;
explain_options?: dependency_8.ExplainOptions;
} & (({
structured_aggregation_query?: dependency_7.StructuredAggregationQuery;
}) | ({
transaction?: Uint8Array;
new_transaction?: never;
read_time?: never;
} | {
transaction?: never;
new_transaction?: dependency_5.TransactionOptions;
read_time?: never;
} | {
transaction?: never;
new_transaction?: never;
read_time?: dependency_11.Timestamp;
}))));
get parent(): string;
set parent(value: string);
get structured_aggregation_query(): dependency_7.StructuredAggregationQuery;
set structured_aggregation_query(value: dependency_7.StructuredAggregationQuery);
get has_structured_aggregation_query(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get has_transaction(): boolean;
get new_transaction(): dependency_5.TransactionOptions;
set new_transaction(value: dependency_5.TransactionOptions);
get has_new_transaction(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get explain_options(): dependency_8.ExplainOptions;
set explain_options(value: dependency_8.ExplainOptions);
get has_explain_options(): boolean;
get query_type(): "none" | "structured_aggregation_query";
get consistency_selector(): "none" | "read_time" | "transaction" | "new_transaction";
static fromObject(data: {
parent?: string;
structured_aggregation_query?: ReturnType<typeof dependency_7.StructuredAggregationQuery.prototype.toObject>;
transaction?: Uint8Array;
new_transaction?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
explain_options?: ReturnType<typeof dependency_8.ExplainOptions.prototype.toObject>;
}): RunAggregationQueryRequest;
toObject(): {
parent?: string;
structured_aggregation_query?: ReturnType<typeof dependency_7.StructuredAggregationQuery.prototype.toObject>;
transaction?: Uint8Array;
new_transaction?: ReturnType<typeof dependency_5.TransactionOptions.prototype.toObject>;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
explain_options?: ReturnType<typeof dependency_8.ExplainOptions.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): RunAggregationQueryRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): RunAggregationQueryRequest;
}
export declare class RunAggregationQueryResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
result?: dependency_4.AggregationResult;
transaction?: Uint8Array;
read_time?: dependency_11.Timestamp;
explain_metrics?: dependency_8.ExplainMetrics;
});
get result(): dependency_4.AggregationResult;
set result(value: dependency_4.AggregationResult);
get has_result(): boolean;
get transaction(): Uint8Array;
set transaction(value: Uint8Array);
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get explain_metrics(): dependency_8.ExplainMetrics;
set explain_metrics(value: dependency_8.ExplainMetrics);
get has_explain_metrics(): boolean;
static fromObject(data: {
result?: ReturnType<typeof dependency_4.AggregationResult.prototype.toObject>;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
explain_metrics?: ReturnType<typeof dependency_8.ExplainMetrics.prototype.toObject>;
}): RunAggregationQueryResponse;
toObject(): {
result?: ReturnType<typeof dependency_4.AggregationResult.prototype.toObject>;
transaction?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
explain_metrics?: ReturnType<typeof dependency_8.ExplainMetrics.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): RunAggregationQueryResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): RunAggregationQueryResponse;
}
export declare class PartitionQueryRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
parent?: string;
partition_count?: number;
page_token?: string;
page_size?: number;
} & (({
structured_query?: dependency_7.StructuredQuery;
}) | ({
read_time?: dependency_11.Timestamp;
}))));
get parent(): string;
set parent(value: string);
get structured_query(): dependency_7.StructuredQuery;
set structured_query(value: dependency_7.StructuredQuery);
get has_structured_query(): boolean;
get partition_count(): number;
set partition_count(value: number);
get page_token(): string;
set page_token(value: string);
get page_size(): number;
set page_size(value: number);
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get query_type(): "none" | "structured_query";
get consistency_selector(): "none" | "read_time";
static fromObject(data: {
parent?: string;
structured_query?: ReturnType<typeof dependency_7.StructuredQuery.prototype.toObject>;
partition_count?: number;
page_token?: string;
page_size?: number;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): PartitionQueryRequest;
toObject(): {
parent?: string;
structured_query?: ReturnType<typeof dependency_7.StructuredQuery.prototype.toObject>;
partition_count?: number;
page_token?: string;
page_size?: number;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): PartitionQueryRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): PartitionQueryRequest;
}
export declare class PartitionQueryResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
partitions?: dependency_7.Cursor[];
next_page_token?: string;
});
get partitions(): dependency_7.Cursor[];
set partitions(value: dependency_7.Cursor[]);
get next_page_token(): string;
set next_page_token(value: string);
static fromObject(data: {
partitions?: ReturnType<typeof dependency_7.Cursor.prototype.toObject>[];
next_page_token?: string;
}): PartitionQueryResponse;
toObject(): {
partitions?: ReturnType<typeof dependency_7.Cursor.prototype.toObject>[];
next_page_token?: string;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): PartitionQueryResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): PartitionQueryResponse;
}
export declare class WriteRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
database?: string;
stream_id?: string;
writes?: dependency_9.Write[];
stream_token?: Uint8Array;
labels?: Map<string, string>;
});
get database(): string;
set database(value: string);
get stream_id(): string;
set stream_id(value: string);
get writes(): dependency_9.Write[];
set writes(value: dependency_9.Write[]);
get stream_token(): Uint8Array;
set stream_token(value: Uint8Array);
get labels(): Map<string, string>;
set labels(value: Map<string, string>);
static fromObject(data: {
database?: string;
stream_id?: string;
writes?: ReturnType<typeof dependency_9.Write.prototype.toObject>[];
stream_token?: Uint8Array;
labels?: {
[key: string]: string;
};
}): WriteRequest;
toObject(): {
database?: string;
stream_id?: string;
writes?: ReturnType<typeof dependency_9.Write.prototype.toObject>[];
stream_token?: Uint8Array;
labels?: {
[key: string]: string;
};
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): WriteRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): WriteRequest;
}
export declare class WriteResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
stream_id?: string;
stream_token?: Uint8Array;
write_results?: dependency_9.WriteResult[];
commit_time?: dependency_11.Timestamp;
});
get stream_id(): string;
set stream_id(value: string);
get stream_token(): Uint8Array;
set stream_token(value: Uint8Array);
get write_results(): dependency_9.WriteResult[];
set write_results(value: dependency_9.WriteResult[]);
get commit_time(): dependency_11.Timestamp;
set commit_time(value: dependency_11.Timestamp);
get has_commit_time(): boolean;
static fromObject(data: {
stream_id?: string;
stream_token?: Uint8Array;
write_results?: ReturnType<typeof dependency_9.WriteResult.prototype.toObject>[];
commit_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): WriteResponse;
toObject(): {
stream_id?: string;
stream_token?: Uint8Array;
write_results?: ReturnType<typeof dependency_9.WriteResult.prototype.toObject>[];
commit_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): WriteResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): WriteResponse;
}
export declare class ListenRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
database?: string;
labels?: Map<string, string>;
} & (({
add_target?: Target;
remove_target?: never;
} | {
add_target?: never;
remove_target?: number;
}))));
get database(): string;
set database(value: string);
get add_target(): Target;
set add_target(value: Target);
get has_add_target(): boolean;
get remove_target(): number;
set remove_target(value: number);
get has_remove_target(): boolean;
get labels(): Map<string, string>;
set labels(value: Map<string, string>);
get target_change(): "none" | "add_target" | "remove_target";
static fromObject(data: {
database?: string;
add_target?: ReturnType<typeof Target.prototype.toObject>;
remove_target?: number;
labels?: {
[key: string]: string;
};
}): ListenRequest;
toObject(): {
database?: string;
add_target?: ReturnType<typeof Target.prototype.toObject>;
remove_target?: number;
labels?: {
[key: string]: string;
};
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ListenRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ListenRequest;
}
export declare class ListenResponse extends pb_1.Message {
#private;
constructor(data?: any[] | ({} & (({
target_change?: TargetChange;
document_change?: never;
document_delete?: never;
document_remove?: never;
filter?: never;
} | {
target_change?: never;
document_change?: dependency_9.DocumentChange;
document_delete?: never;
document_remove?: never;
filter?: never;
} | {
target_change?: never;
document_change?: never;
document_delete?: dependency_9.DocumentDelete;
document_remove?: never;
filter?: never;
} | {
target_change?: never;
document_change?: never;
document_delete?: never;
document_remove?: dependency_9.DocumentRemove;
filter?: never;
} | {
target_change?: never;
document_change?: never;
document_delete?: never;
document_remove?: never;
filter?: dependency_9.ExistenceFilter;
}))));
get target_change(): TargetChange;
set target_change(value: TargetChange);
get has_target_change(): boolean;
get document_change(): dependency_9.DocumentChange;
set document_change(value: dependency_9.DocumentChange);
get has_document_change(): boolean;
get document_delete(): dependency_9.DocumentDelete;
set document_delete(value: dependency_9.DocumentDelete);
get has_document_delete(): boolean;
get document_remove(): dependency_9.DocumentRemove;
set document_remove(value: dependency_9.DocumentRemove);
get has_document_remove(): boolean;
get filter(): dependency_9.ExistenceFilter;
set filter(value: dependency_9.ExistenceFilter);
get has_filter(): boolean;
get response_type(): "filter" | "none" | "target_change" | "document_change" | "document_delete" | "document_remove";
static fromObject(data: {
target_change?: ReturnType<typeof TargetChange.prototype.toObject>;
document_change?: ReturnType<typeof dependency_9.DocumentChange.prototype.toObject>;
document_delete?: ReturnType<typeof dependency_9.DocumentDelete.prototype.toObject>;
document_remove?: ReturnType<typeof dependency_9.DocumentRemove.prototype.toObject>;
filter?: ReturnType<typeof dependency_9.ExistenceFilter.prototype.toObject>;
}): ListenResponse;
toObject(): {
target_change?: ReturnType<typeof TargetChange.prototype.toObject>;
document_change?: ReturnType<typeof dependency_9.DocumentChange.prototype.toObject>;
document_delete?: ReturnType<typeof dependency_9.DocumentDelete.prototype.toObject>;
document_remove?: ReturnType<typeof dependency_9.DocumentRemove.prototype.toObject>;
filter?: ReturnType<typeof dependency_9.ExistenceFilter.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ListenResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ListenResponse;
}
export declare class Target extends pb_1.Message {
#private;
constructor(data?: any[] | ({
target_id?: number;
once?: boolean;
expected_count?: dependency_12.Int32Value;
} & (({
query?: TargetQueryTarget;
documents?: never;
} | {
query?: never;
documents?: TargetDocumentsTarget;
}) | ({
resume_token?: Uint8Array;
read_time?: never;
} | {
resume_token?: never;
read_time?: dependency_11.Timestamp;
}))));
get query(): TargetQueryTarget;
set query(value: TargetQueryTarget);
get has_query(): boolean;
get documents(): TargetDocumentsTarget;
set documents(value: TargetDocumentsTarget);
get has_documents(): boolean;
get resume_token(): Uint8Array;
set resume_token(value: Uint8Array);
get has_resume_token(): boolean;
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get target_id(): number;
set target_id(value: number);
get once(): boolean;
set once(value: boolean);
get expected_count(): dependency_12.Int32Value;
set expected_count(value: dependency_12.Int32Value);
get has_expected_count(): boolean;
get target_type(): "none" | "query" | "documents";
get resume_type(): "none" | "read_time" | "resume_token";
static fromObject(data: {
query?: ReturnType<typeof TargetQueryTarget.prototype.toObject>;
documents?: ReturnType<typeof TargetDocumentsTarget.prototype.toObject>;
resume_token?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
target_id?: number;
once?: boolean;
expected_count?: ReturnType<typeof dependency_12.Int32Value.prototype.toObject>;
}): Target;
toObject(): {
query?: ReturnType<typeof TargetQueryTarget.prototype.toObject>;
documents?: ReturnType<typeof TargetDocumentsTarget.prototype.toObject>;
resume_token?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
target_id?: number;
once?: boolean;
expected_count?: ReturnType<typeof dependency_12.Int32Value.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): Target;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): Target;
}
export declare class TargetDocumentsTarget extends pb_1.Message {
#private;
constructor(data?: any[] | {
documents?: string[];
});
get documents(): string[];
set documents(value: string[]);
static fromObject(data: {
documents?: string[];
}): TargetDocumentsTarget;
toObject(): {
documents?: string[];
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): TargetDocumentsTarget;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): TargetDocumentsTarget;
}
export declare class TargetQueryTarget extends pb_1.Message {
#private;
constructor(data?: any[] | ({
parent?: string;
} & (({
structured_query?: dependency_7.StructuredQuery;
}))));
get parent(): string;
set parent(value: string);
get structured_query(): dependency_7.StructuredQuery;
set structured_query(value: dependency_7.StructuredQuery);
get has_structured_query(): boolean;
get query_type(): "none" | "structured_query";
static fromObject(data: {
parent?: string;
structured_query?: ReturnType<typeof dependency_7.StructuredQuery.prototype.toObject>;
}): TargetQueryTarget;
toObject(): {
parent?: string;
structured_query?: ReturnType<typeof dependency_7.StructuredQuery.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): TargetQueryTarget;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): TargetQueryTarget;
}
export declare class TargetChange extends pb_1.Message {
#private;
constructor(data?: any[] | {
target_change_type?: TargetChangeTargetChangeType;
target_ids?: number[];
cause?: dependency_13.Status;
resume_token?: Uint8Array;
read_time?: dependency_11.Timestamp;
});
get target_change_type(): TargetChangeTargetChangeType;
set target_change_type(value: TargetChangeTargetChangeType);
get target_ids(): number[];
set target_ids(value: number[]);
get cause(): dependency_13.Status;
set cause(value: dependency_13.Status);
get has_cause(): boolean;
get resume_token(): Uint8Array;
set resume_token(value: Uint8Array);
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
static fromObject(data: {
target_change_type?: TargetChangeTargetChangeType;
target_ids?: number[];
cause?: ReturnType<typeof dependency_13.Status.prototype.toObject>;
resume_token?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): TargetChange;
toObject(): {
target_change_type?: TargetChangeTargetChangeType;
target_ids?: number[];
cause?: ReturnType<typeof dependency_13.Status.prototype.toObject>;
resume_token?: Uint8Array;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): TargetChange;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): TargetChange;
}
export declare enum TargetChangeTargetChangeType {
NO_CHANGE = 0,
ADD = 1,
REMOVE = 2,
CURRENT = 3,
RESET = 4
}
export declare class ListCollectionIdsRequest extends pb_1.Message {
#private;
constructor(data?: any[] | ({
parent?: string;
page_size?: number;
page_token?: string;
} & (({
read_time?: dependency_11.Timestamp;
}))));
get parent(): string;
set parent(value: string);
get page_size(): number;
set page_size(value: number);
get page_token(): string;
set page_token(value: string);
get read_time(): dependency_11.Timestamp;
set read_time(value: dependency_11.Timestamp);
get has_read_time(): boolean;
get consistency_selector(): "none" | "read_time";
static fromObject(data: {
parent?: string;
page_size?: number;
page_token?: string;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
}): ListCollectionIdsRequest;
toObject(): {
parent?: string;
page_size?: number;
page_token?: string;
read_time?: ReturnType<typeof dependency_11.Timestamp.prototype.toObject>;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ListCollectionIdsRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ListCollectionIdsRequest;
}
export declare class ListCollectionIdsResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
collection_ids?: string[];
next_page_token?: string;
});
get collection_ids(): string[];
set collection_ids(value: string[]);
get next_page_token(): string;
set next_page_token(value: string);
static fromObject(data: {
collection_ids?: string[];
next_page_token?: string;
}): ListCollectionIdsResponse;
toObject(): {
collection_ids?: string[];
next_page_token?: string;
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): ListCollectionIdsResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): ListCollectionIdsResponse;
}
export declare class BatchWriteRequest extends pb_1.Message {
#private;
constructor(data?: any[] | {
database?: string;
writes?: dependency_9.Write[];
labels?: Map<string, string>;
});
get database(): string;
set database(value: string);
get writes(): dependency_9.Write[];
set writes(value: dependency_9.Write[]);
get labels(): Map<string, string>;
set labels(value: Map<string, string>);
static fromObject(data: {
database?: string;
writes?: ReturnType<typeof dependency_9.Write.prototype.toObject>[];
labels?: {
[key: string]: string;
};
}): BatchWriteRequest;
toObject(): {
database?: string;
writes?: ReturnType<typeof dependency_9.Write.prototype.toObject>[];
labels?: {
[key: string]: string;
};
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BatchWriteRequest;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BatchWriteRequest;
}
export declare class BatchWriteResponse extends pb_1.Message {
#private;
constructor(data?: any[] | {
write_results?: dependency_9.WriteResult[];
status?: dependency_13.Status[];
});
get write_results(): dependency_9.WriteResult[];
set write_results(value: dependency_9.WriteResult[]);
get status(): dependency_13.Status[];
set status(value: dependency_13.Status[]);
static fromObject(data: {
write_results?: ReturnType<typeof dependency_9.WriteResult.prototype.toObject>[];
status?: ReturnType<typeof dependency_13.Status.prototype.toObject>[];
}): BatchWriteResponse;
toObject(): {
write_results?: ReturnType<typeof dependency_9.WriteResult.prototype.toObject>[];
status?: ReturnType<typeof dependency_13.Status.prototype.toObject>[];
};
serialize(): Uint8Array;
serialize(w: pb_1.BinaryWriter): void;
static deserialize(bytes: Uint8Array | pb_1.BinaryReader): BatchWriteResponse;
serializeBinary(): Uint8Array;
static deserializeBinary(bytes: Uint8Array): BatchWriteResponse;
}
interface GrpcUnaryServiceInterface<P, R> {
(message: P, metadata: grpc_1.Metadata, options: grpc_1.CallOptions, callback: grpc_1.requestCallback<R>): grpc_1.ClientUnaryCall;
(message: P, metadata: grpc_1.Metadata, callback: grpc_1.requestCallback<R>): grpc_1.ClientUnaryCall;
(message: P, options: grpc_1.CallOptions, callback: grpc_1.requestCallback<R>): grpc_1.ClientUnaryCall;
(message: P, callback: grpc_1.requestCallback<R>): grpc_1.ClientUnaryCall;
}
interface GrpcStreamServiceInterface<P, R> {
(message: P, metadata: grpc_1.Metadata, options?: grpc_1.CallOptions): grpc_1.ClientReadableStream<R>;
(message: P, options?: grpc_1.CallOptions): grpc_1.ClientReadableStream<R>;
}
interface GrpcChunkServiceInterface<P, R> {
(metadata: grpc_1.Metadata, options?: grpc_1.CallOptions): grpc_1.ClientDuplexStream<P, R>;
(options?: grpc_1.CallOptions): grpc_1.ClientDuplexStream<P, R>;
}
export declare abstract class UnimplementedFirestoreService {
static definition: {
GetDocument: {