weave-typescript 0.1.0

package/dist/weave/datamanagement/storage/v1/service.pb.d.ts

@@ -0,0 +1,257 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { type CallOptions, ChannelCredentials, Client, type ClientOptions, type ClientUnaryCall, type handleUnaryCall, Metadata, type ServiceError, type UntypedServiceImplementation } from "@grpc/grpc-js";
+import { StorageConnection } from "./storage.pb";
+export declare const protobufPackage = "weave.datamanagement.storage.v1";
+/** StorageConfig represents a named storage configuration with metadata */
+export interface StorageDetails {
+    /** Unique identifier for the storage configuration */
+    id: string;
+    /** User-friendly name for the storage configuration */
+    name: string;
+    /** Optional description */
+    description: string;
+    /** The actual storage configuration */
+    storageConnection: StorageConnection | undefined;
+}
+/** CreateStorageRequest is used to create a new storage configuration */
+export interface CreateStorageRequest {
+    /** User-friendly name for the storage configuration */
+    name: string;
+    /** Optional description */
+    description: string;
+    /** The storage configuration to create */
+    storageConnection: StorageConnection | undefined;
+}
+/** CreateStorageResponse contains the created storage configuration */
+export interface CreateStorageResponse {
+    /** The created storage configuration */
+    storageDetails: StorageDetails | undefined;
+}
+/** GetStorageRequest is used to retrieve a storage configuration by ID */
+export interface GetStorageRequest {
+    /** ID of the storage configuration to retrieve */
+    id: string;
+}
+/** GetStorageResponse contains the requested storage configuration */
+export interface GetStorageResponse {
+    /** The requested storage configuration */
+    storageDetails: StorageDetails | undefined;
+}
+/** ListStoragesRequest is used to list storage configurations with optional filtering */
+export interface ListStoragesRequest {
+    /** Maximum number of results to return */
+    pageSize: number;
+    /** Token for pagination */
+    pageToken: string;
+    /** Optional filter by storage type */
+    storageTypeFilter: StorageTypeFilter | undefined;
+}
+/** StorageTypeFilter allows filtering storage configurations by type */
+export interface StorageTypeFilter {
+    /** If true, include object stores */
+    includeObjectStores: boolean;
+    /** If true, include SQL databases */
+    includeSqlDatabases: boolean;
+    /** If true, include NoSQL databases */
+    includeNosqlDatabases: boolean;
+}
+/** ListStoragesResponse contains the list of storage configurations */
+export interface ListStoragesResponse {
+    /** List of storage configurations */
+    storageDetails: StorageDetails[];
+    /** Token for pagination */
+    nextPageToken: string;
+    /** Total count of storage configurations matching the request */
+    totalCount: number;
+}
+/** UpdateStorageRequest is used to update an existing storage configuration */
+export interface UpdateStorageRequest {
+    /** ID of the storage configuration to update */
+    id: string;
+    /** New name (optional) */
+    name: string;
+    /** New description (optional) */
+    description: string;
+    /** New storage configuration (optional) */
+    storageConnection: StorageConnection | undefined;
+}
+/** UpdateStorageResponse contains the updated storage configuration */
+export interface UpdateStorageResponse {
+    /** The updated storage configuration */
+    storageConfig: StorageDetails | undefined;
+}
+/** DeleteStorageRequest is used to delete a storage configuration */
+export interface DeleteStorageRequest {
+    /** ID of the storage configuration to delete */
+    id: string;
+}
+export interface DeleteStorageResponse {
+}
+/** TestStorageConnectionRequest is used to test a storage connection */
+export interface TestStorageConnectionRequest {
+    /** ID of an existing storage configuration */
+    id?: string | undefined;
+    /** A new storage configuration to test */
+    storageConnection?: StorageConnection | undefined;
+}
+/** TestStorageConnectionResponse contains the result of a connection test */
+export interface TestStorageConnectionResponse {
+    /** Whether the connection was successful */
+    success: boolean;
+    /** Error message if the connection failed */
+    errorMessage: string;
+    /** Additional details about the connection test */
+    connectionDetails: ConnectionDetails | undefined;
+}
+/** ConnectionDetails provides additional information about a storage connection */
+export interface ConnectionDetails {
+    /** Connection latency in milliseconds */
+    latencyMs: number;
+    /** For SQL/NoSQL databases: available tables/collections */
+    availableResources: string[];
+    /** For object stores: available buckets/containers */
+    availableContainers: string[];
+}
+export declare const StorageDetails: MessageFns<StorageDetails>;
+export declare const CreateStorageRequest: MessageFns<CreateStorageRequest>;
+export declare const CreateStorageResponse: MessageFns<CreateStorageResponse>;
+export declare const GetStorageRequest: MessageFns<GetStorageRequest>;
+export declare const GetStorageResponse: MessageFns<GetStorageResponse>;
+export declare const ListStoragesRequest: MessageFns<ListStoragesRequest>;
+export declare const StorageTypeFilter: MessageFns<StorageTypeFilter>;
+export declare const ListStoragesResponse: MessageFns<ListStoragesResponse>;
+export declare const UpdateStorageRequest: MessageFns<UpdateStorageRequest>;
+export declare const UpdateStorageResponse: MessageFns<UpdateStorageResponse>;
+export declare const DeleteStorageRequest: MessageFns<DeleteStorageRequest>;
+export declare const DeleteStorageResponse: MessageFns<DeleteStorageResponse>;
+export declare const TestStorageConnectionRequest: MessageFns<TestStorageConnectionRequest>;
+export declare const TestStorageConnectionResponse: MessageFns<TestStorageConnectionResponse>;
+export declare const ConnectionDetails: MessageFns<ConnectionDetails>;
+/** Storage provides CRUD operations for managing storage configurations */
+export type StorageService = typeof StorageService;
+export declare const StorageService: {
+    /** CreateStorage creates a new storage configuration */
+    readonly createStorage: {
+        readonly path: "/weave.datamanagement.storage.v1.Storage/CreateStorage";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: CreateStorageRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => CreateStorageRequest;
+        readonly responseSerialize: (value: CreateStorageResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => CreateStorageResponse;
+    };
+    /** GetStorage retrieves a storage configuration by ID */
+    readonly getStorage: {
+        readonly path: "/weave.datamanagement.storage.v1.Storage/GetStorage";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: GetStorageRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => GetStorageRequest;
+        readonly responseSerialize: (value: GetStorageResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => GetStorageResponse;
+    };
+    /** ListStorages retrieves all storage configurations with optional filtering */
+    readonly listStorages: {
+        readonly path: "/weave.datamanagement.storage.v1.Storage/ListStorages";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: ListStoragesRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => ListStoragesRequest;
+        readonly responseSerialize: (value: ListStoragesResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => ListStoragesResponse;
+    };
+    /** UpdateStorage updates an existing storage configuration */
+    readonly updateStorage: {
+        readonly path: "/weave.datamanagement.storage.v1.Storage/UpdateStorage";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: UpdateStorageRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => UpdateStorageRequest;
+        readonly responseSerialize: (value: UpdateStorageResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => UpdateStorageResponse;
+    };
+    /** DeleteStorage deletes a storage configuration by ID */
+    readonly deleteStorage: {
+        readonly path: "/weave.datamanagement.storage.v1.Storage/DeleteStorage";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: DeleteStorageRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => DeleteStorageRequest;
+        readonly responseSerialize: (value: DeleteStorageResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => DeleteStorageResponse;
+    };
+    /** TestStorageConnection tests the connection to a storage */
+    readonly testStorageConnection: {
+        readonly path: "/weave.datamanagement.storage.v1.Storage/TestStorageConnection";
+        readonly requestStream: false;
+        readonly responseStream: false;
+        readonly requestSerialize: (value: TestStorageConnectionRequest) => Buffer<ArrayBuffer>;
+        readonly requestDeserialize: (value: Buffer) => TestStorageConnectionRequest;
+        readonly responseSerialize: (value: TestStorageConnectionResponse) => Buffer<ArrayBuffer>;
+        readonly responseDeserialize: (value: Buffer) => TestStorageConnectionResponse;
+    };
+};
+export interface StorageServer extends UntypedServiceImplementation {
+    /** CreateStorage creates a new storage configuration */
+    createStorage: handleUnaryCall<CreateStorageRequest, CreateStorageResponse>;
+    /** GetStorage retrieves a storage configuration by ID */
+    getStorage: handleUnaryCall<GetStorageRequest, GetStorageResponse>;
+    /** ListStorages retrieves all storage configurations with optional filtering */
+    listStorages: handleUnaryCall<ListStoragesRequest, ListStoragesResponse>;
+    /** UpdateStorage updates an existing storage configuration */
+    updateStorage: handleUnaryCall<UpdateStorageRequest, UpdateStorageResponse>;
+    /** DeleteStorage deletes a storage configuration by ID */
+    deleteStorage: handleUnaryCall<DeleteStorageRequest, DeleteStorageResponse>;
+    /** TestStorageConnection tests the connection to a storage */
+    testStorageConnection: handleUnaryCall<TestStorageConnectionRequest, TestStorageConnectionResponse>;
+}
+export interface StorageClient extends Client {
+    /** CreateStorage creates a new storage configuration */
+    createStorage(request: CreateStorageRequest, callback: (error: ServiceError | null, response: CreateStorageResponse) => void): ClientUnaryCall;
+    createStorage(request: CreateStorageRequest, metadata: Metadata, callback: (error: ServiceError | null, response: CreateStorageResponse) => void): ClientUnaryCall;
+    createStorage(request: CreateStorageRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: CreateStorageResponse) => void): ClientUnaryCall;
+    /** GetStorage retrieves a storage configuration by ID */
+    getStorage(request: GetStorageRequest, callback: (error: ServiceError | null, response: GetStorageResponse) => void): ClientUnaryCall;
+    getStorage(request: GetStorageRequest, metadata: Metadata, callback: (error: ServiceError | null, response: GetStorageResponse) => void): ClientUnaryCall;
+    getStorage(request: GetStorageRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: GetStorageResponse) => void): ClientUnaryCall;
+    /** ListStorages retrieves all storage configurations with optional filtering */
+    listStorages(request: ListStoragesRequest, callback: (error: ServiceError | null, response: ListStoragesResponse) => void): ClientUnaryCall;
+    listStorages(request: ListStoragesRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ListStoragesResponse) => void): ClientUnaryCall;
+    listStorages(request: ListStoragesRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ListStoragesResponse) => void): ClientUnaryCall;
+    /** UpdateStorage updates an existing storage configuration */
+    updateStorage(request: UpdateStorageRequest, callback: (error: ServiceError | null, response: UpdateStorageResponse) => void): ClientUnaryCall;
+    updateStorage(request: UpdateStorageRequest, metadata: Metadata, callback: (error: ServiceError | null, response: UpdateStorageResponse) => void): ClientUnaryCall;
+    updateStorage(request: UpdateStorageRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: UpdateStorageResponse) => void): ClientUnaryCall;
+    /** DeleteStorage deletes a storage configuration by ID */
+    deleteStorage(request: DeleteStorageRequest, callback: (error: ServiceError | null, response: DeleteStorageResponse) => void): ClientUnaryCall;
+    deleteStorage(request: DeleteStorageRequest, metadata: Metadata, callback: (error: ServiceError | null, response: DeleteStorageResponse) => void): ClientUnaryCall;
+    deleteStorage(request: DeleteStorageRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: DeleteStorageResponse) => void): ClientUnaryCall;
+    /** TestStorageConnection tests the connection to a storage */
+    testStorageConnection(request: TestStorageConnectionRequest, callback: (error: ServiceError | null, response: TestStorageConnectionResponse) => void): ClientUnaryCall;
+    testStorageConnection(request: TestStorageConnectionRequest, metadata: Metadata, callback: (error: ServiceError | null, response: TestStorageConnectionResponse) => void): ClientUnaryCall;
+    testStorageConnection(request: TestStorageConnectionRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: TestStorageConnectionResponse) => void): ClientUnaryCall;
+}
+export declare const StorageClient: {
+    new (address: string, credentials: ChannelCredentials, options?: Partial<ClientOptions>): StorageClient;
+    service: typeof StorageService;
+    serviceName: string;
+};
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};