@ydbjs/api
Version:
TypeScript gRPC service definitions and protobuf types for all YDB APIs. Enables strongly-typed client generation and low-level protocol access.
122 lines • 4.13 kB
TypeScript
import type { GenEnum, GenFile, GenMessage } from "@bufbuild/protobuf/codegenv1";
import type { Operation } from "./ydb_operation_pb.js";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file protos/ydb_federation_discovery.proto.
*/
export declare const file_protos_ydb_federation_discovery: GenFile;
/**
* @generated from message Ydb.FederationDiscovery.DatabaseInfo
*/
export type DatabaseInfo = Message<"Ydb.FederationDiscovery.DatabaseInfo"> & {
/**
* @generated from field: string name = 1;
*/
name: string;
/**
* @generated from field: string path = 2;
*/
path: string;
/**
* @generated from field: string id = 3;
*/
id: string;
/**
* @generated from field: string endpoint = 4;
*/
endpoint: string;
/**
* for single datacenter databases
*
* @generated from field: string location = 5;
*/
location: string;
/**
* @generated from field: Ydb.FederationDiscovery.DatabaseInfo.Status status = 6;
*/
status: DatabaseInfo_Status;
/**
* to determine this database priority on the client side
*
* @generated from field: int64 weight = 7;
*/
weight: bigint;
};
/**
* Describes the message Ydb.FederationDiscovery.DatabaseInfo.
* Use `create(DatabaseInfoSchema)` to create a new message.
*/
export declare const DatabaseInfoSchema: GenMessage<DatabaseInfo>;
/**
* @generated from enum Ydb.FederationDiscovery.DatabaseInfo.Status
*/
export declare enum DatabaseInfo_Status {
/**
* @generated from enum value: STATUS_UNSPECIFIED = 0;
*/
STATUS_UNSPECIFIED = 0,
/**
* @generated from enum value: AVAILABLE = 1;
*/
AVAILABLE = 1,
/**
* @generated from enum value: READ_ONLY = 2;
*/
READ_ONLY = 2,
/**
* @generated from enum value: UNAVAILABLE = 3;
*/
UNAVAILABLE = 3
}
/**
* Describes the enum Ydb.FederationDiscovery.DatabaseInfo.Status.
*/
export declare const DatabaseInfo_StatusSchema: GenEnum<DatabaseInfo_Status>;
/**
* @generated from message Ydb.FederationDiscovery.ListFederationDatabasesRequest
*/
export type ListFederationDatabasesRequest = Message<"Ydb.FederationDiscovery.ListFederationDatabasesRequest"> & {};
/**
* Describes the message Ydb.FederationDiscovery.ListFederationDatabasesRequest.
* Use `create(ListFederationDatabasesRequestSchema)` to create a new message.
*/
export declare const ListFederationDatabasesRequestSchema: GenMessage<ListFederationDatabasesRequest>;
/**
* @generated from message Ydb.FederationDiscovery.ListFederationDatabasesResponse
*/
export type ListFederationDatabasesResponse = Message<"Ydb.FederationDiscovery.ListFederationDatabasesResponse"> & {
/**
* Operation contains the result of the request. Check the ydb_operation.proto.
*
* @generated from field: Ydb.Operations.Operation operation = 1;
*/
operation?: Operation;
};
/**
* Describes the message Ydb.FederationDiscovery.ListFederationDatabasesResponse.
* Use `create(ListFederationDatabasesResponseSchema)` to create a new message.
*/
export declare const ListFederationDatabasesResponseSchema: GenMessage<ListFederationDatabasesResponse>;
/**
* @generated from message Ydb.FederationDiscovery.ListFederationDatabasesResult
*/
export type ListFederationDatabasesResult = Message<"Ydb.FederationDiscovery.ListFederationDatabasesResult"> & {
/**
* @generated from field: string control_plane_endpoint = 1;
*/
controlPlaneEndpoint: string;
/**
* @generated from field: repeated Ydb.FederationDiscovery.DatabaseInfo federation_databases = 2;
*/
federationDatabases: DatabaseInfo[];
/**
* @generated from field: string self_location = 3;
*/
selfLocation: string;
};
/**
* Describes the message Ydb.FederationDiscovery.ListFederationDatabasesResult.
* Use `create(ListFederationDatabasesResultSchema)` to create a new message.
*/
export declare const ListFederationDatabasesResultSchema: GenMessage<ListFederationDatabasesResult>;
//# sourceMappingURL=ydb_federation_discovery_pb.d.ts.map