@yandex-cloud/nodejs-sdk/dist/generated/yandex/cloud/mdb/opensearch/v1/backup_service.d.ts

Yandex.Cloud NodeJS SDK

/// <reference types="node" />
import { ChannelCredentials, ChannelOptions, UntypedServiceImplementation, handleUnaryCall, Client, ClientUnaryCall, Metadata, CallOptions, ServiceError } from "@grpc/grpc-js";
import _m0 from "protobufjs/minimal";
import { Backup } from "../../../../../yandex/cloud/mdb/opensearch/v1/backup";
export declare const protobufPackage = "yandex.cloud.mdb.opensearch.v1";
export interface GetBackupRequest {
    $type: "yandex.cloud.mdb.opensearch.v1.GetBackupRequest";
    /** ID of the backup to return. */
    backupId: string;
}
export interface ListBackupsRequest {
    $type: "yandex.cloud.mdb.opensearch.v1.ListBackupsRequest";
    /** ID of the folder to list backups in. */
    folderId: string;
    /**
     * 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 [ListBackupsResponse.next_page_token] that can be used to get the next page of results
     * in subsequent list requests.
     *
     * Default value is 100.
     */
    pageSize: number;
    /**
     * The page token. To get the next page of results, set [page_token] to the [ListBackupsResponse.next_page_token]
     * returned by the previous list request.
     */
    pageToken: string;
}
export interface ListBackupsResponse {
    $type: "yandex.cloud.mdb.opensearch.v1.ListBackupsResponse";
    /** Requested list of backups. */
    backups: Backup[];
    /**
     * This token allows you to get the next page of results for a list request.
     *
     * If the number of results is larger than [ListBackupsRequest.page_size] specified in the request,
     * use the [next_page_token] as the value for the [ListBackupsRequest.page_token] parameter in the next list request.
     *
     * Each subsequent ListBackups request has its own [next_page_token] to continue paging through the results.
     */
    nextPageToken: string;
}
export declare const GetBackupRequest: {
    $type: "yandex.cloud.mdb.opensearch.v1.GetBackupRequest";
    encode(message: GetBackupRequest, writer?: _m0.Writer): _m0.Writer;
    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): GetBackupRequest;
    fromJSON(object: any): GetBackupRequest;
    toJSON(message: GetBackupRequest): unknown;
    fromPartial<I extends {
        backupId?: string | undefined;
    } & {
        backupId?: string | undefined;
    } & Record<Exclude<keyof I, "$type" | "backupId">, never>>(object: I): GetBackupRequest;
};
export declare const ListBackupsRequest: {
    $type: "yandex.cloud.mdb.opensearch.v1.ListBackupsRequest";
    encode(message: ListBackupsRequest, writer?: _m0.Writer): _m0.Writer;
    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListBackupsRequest;
    fromJSON(object: any): ListBackupsRequest;
    toJSON(message: ListBackupsRequest): unknown;
    fromPartial<I extends {
        pageSize?: number | undefined;
        pageToken?: string | undefined;
        folderId?: string | undefined;
    } & {
        pageSize?: number | undefined;
        pageToken?: string | undefined;
        folderId?: string | undefined;
    } & Record<Exclude<keyof I, "$type" | "pageSize" | "pageToken" | "folderId">, never>>(object: I): ListBackupsRequest;
};
export declare const ListBackupsResponse: {
    $type: "yandex.cloud.mdb.opensearch.v1.ListBackupsResponse";
    encode(message: ListBackupsResponse, writer?: _m0.Writer): _m0.Writer;
    decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListBackupsResponse;
    fromJSON(object: any): ListBackupsResponse;
    toJSON(message: ListBackupsResponse): unknown;
    fromPartial<I extends {
        nextPageToken?: string | undefined;
        backups?: {
            id?: string | undefined;
            createdAt?: Date | undefined;
            folderId?: string | undefined;
            startedAt?: Date | undefined;
            sizeBytes?: number | undefined;
            sourceClusterId?: string | undefined;
            indices?: string[] | undefined;
            indicesTotal?: number | undefined;
            opensearchVersion?: string | undefined;
        }[] | undefined;
    } & {
        nextPageToken?: string | undefined;
        backups?: ({
            id?: string | undefined;
            createdAt?: Date | undefined;
            folderId?: string | undefined;
            startedAt?: Date | undefined;
            sizeBytes?: number | undefined;
            sourceClusterId?: string | undefined;
            indices?: string[] | undefined;
            indicesTotal?: number | undefined;
            opensearchVersion?: string | undefined;
        }[] & ({
            id?: string | undefined;
            createdAt?: Date | undefined;
            folderId?: string | undefined;
            startedAt?: Date | undefined;
            sizeBytes?: number | undefined;
            sourceClusterId?: string | undefined;
            indices?: string[] | undefined;
            indicesTotal?: number | undefined;
            opensearchVersion?: string | undefined;
        } & {
            id?: string | undefined;
            createdAt?: Date | undefined;
            folderId?: string | undefined;
            startedAt?: Date | undefined;
            sizeBytes?: number | undefined;
            sourceClusterId?: string | undefined;
            indices?: (string[] & string[] & Record<Exclude<keyof I["backups"][number]["indices"], "$type" | keyof string[]>, never>) | undefined;
            indicesTotal?: number | undefined;
            opensearchVersion?: string | undefined;
        } & Record<Exclude<keyof I["backups"][number], "$type" | "id" | "createdAt" | "folderId" | "startedAt" | "sizeBytes" | "sourceClusterId" | "indices" | "indicesTotal" | "opensearchVersion">, never>)[] & Record<Exclude<keyof I["backups"], "$type" | keyof {
            id?: string | undefined;
            createdAt?: Date | undefined;
            folderId?: string | undefined;
            startedAt?: Date | undefined;
            sizeBytes?: number | undefined;
            sourceClusterId?: string | undefined;
            indices?: string[] | undefined;
            indicesTotal?: number | undefined;
            opensearchVersion?: string | undefined;
        }[]>, never>) | undefined;
    } & Record<Exclude<keyof I, "$type" | "nextPageToken" | "backups">, never>>(object: I): ListBackupsResponse;
};
/** A set of methods for managing backups. */
export declare const BackupServiceService: {
    /** Returns the specified backup of an OpenSearch cluster. */
    readonly get: {
        readonly path: "/yandex.cloud.mdb.opensearch.v1.BackupService/Get";
        readonly requestStream: false;
        readonly responseStream: false;
        readonly requestSerialize: (value: GetBackupRequest) => Buffer;
        readonly requestDeserialize: (value: Buffer) => GetBackupRequest;
        readonly responseSerialize: (value: Backup) => Buffer;
        readonly responseDeserialize: (value: Buffer) => Backup;
    };
    /** Returns the list of available backups for the specified OpenSearch cluster. */
    readonly list: {
        readonly path: "/yandex.cloud.mdb.opensearch.v1.BackupService/List";
        readonly requestStream: false;
        readonly responseStream: false;
        readonly requestSerialize: (value: ListBackupsRequest) => Buffer;
        readonly requestDeserialize: (value: Buffer) => ListBackupsRequest;
        readonly responseSerialize: (value: ListBackupsResponse) => Buffer;
        readonly responseDeserialize: (value: Buffer) => ListBackupsResponse;
    };
};
export interface BackupServiceServer extends UntypedServiceImplementation {
    /** Returns the specified backup of an OpenSearch cluster. */
    get: handleUnaryCall<GetBackupRequest, Backup>;
    /** Returns the list of available backups for the specified OpenSearch cluster. */
    list: handleUnaryCall<ListBackupsRequest, ListBackupsResponse>;
}
export interface BackupServiceClient extends Client {
    /** Returns the specified backup of an OpenSearch cluster. */
    get(request: GetBackupRequest, callback: (error: ServiceError | null, response: Backup) => void): ClientUnaryCall;
    get(request: GetBackupRequest, metadata: Metadata, callback: (error: ServiceError | null, response: Backup) => void): ClientUnaryCall;
    get(request: GetBackupRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: Backup) => void): ClientUnaryCall;
    /** Returns the list of available backups for the specified OpenSearch cluster. */
    list(request: ListBackupsRequest, callback: (error: ServiceError | null, response: ListBackupsResponse) => void): ClientUnaryCall;
    list(request: ListBackupsRequest, metadata: Metadata, callback: (error: ServiceError | null, response: ListBackupsResponse) => void): ClientUnaryCall;
    list(request: ListBackupsRequest, metadata: Metadata, options: Partial<CallOptions>, callback: (error: ServiceError | null, response: ListBackupsResponse) => void): ClientUnaryCall;
}
export declare const BackupServiceClient: {
    new (address: string, credentials: ChannelCredentials, options?: Partial<ChannelOptions> | undefined): BackupServiceClient;
    service: typeof BackupServiceService;
};
declare type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
export declare type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
    [K in Exclude<keyof T, "$type">]?: DeepPartial<T[K]>;
} : Partial<T>;
declare type KeysOfUnion<T> = T extends T ? keyof T : never;
export declare type Exact<P, I extends P> = P extends Builtin ? P : P & {
    [K in keyof P]: Exact<P[K], I[K]>;
} & Record<Exclude<keyof I, KeysOfUnion<P> | "$type">, never>;
export {};