mongodb-atlas-api-client/src/cloudBackup.d.ts

A mongodb atlas api client for nodejs.

import {ClusterName, Links, AtlasResultsResponse, AtlasClientOptions, AtlasError} from ".";

export interface GetReplicaSetCloudBackup {
    cloudProvider: 'AWS' | 'GCP' | 'AZURE' | 'TENANT';
    copyRegions: string[];
    createdAt: string;
    description?: string;
    expiresAt: string;
    frequencyType: 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly';
    id: string;
    links: Links;
    masterKeyUUID?: string;
    mongodVersion: string;
    policyItems: Array;
    replicaSetName: string;
    snapshotType: 'onDemand' | 'scheduled';
    status: 'queued' | 'inProgress' | 'completed' | 'failed';
    storageSizeBytes: number;
    type: string
}

export type GetAllReplicaSetCloudBackups = AtlasResultsResponse<GetReplicaSetCloudBackup>;

export interface SnapshotRestoreJobComponent {
    replicaSetName: string
}

export type SnapshotRestoreJobComponents = SnapshotRestoreJobComponent[]

export interface GetSnapshotRestoreJob {
    cancelled?: boolean;
    components?: SnapshotRestoreJobComponents;
    deliveryType: 'automated' | 'download' | 'pointInTime';
    deliveryUrl?: string[];
    desiredTimestamp?: {
        date: string;
        increment: number
    };
    expired?: boolean;
    expiresAt?: string;
    failed?: boolean;
    finishedAt?: string;
    id?: string;
    links?: Links;
    oplogInc?: number;
    oplogTs?: number;
    pointInTimeUTCSeconds?: number;
    snapshotId?: string;
    targetClusterName?: string;
    targetGroupId?: string;
    timestamp?: string
}

export interface SnapshotRestoreJobRequest {
    deliveryType: 'automated' | 'download' | 'pointInTime';
    oplogInc?: number;
    oplogTs?: number;
    pointInTimeUTCSeconds?: number;
    snapshotId?: string;
    targetClusterName?: string;
    targetGroupId?: string
}
export type CreateSnapshotRestoreJobResponse = GetSnapshotRestoreJob;

export interface CloudBackup {
    getReplicaSetCloudBackup(clustername: ClusterName, snapshotId: string, options?: AtlasClientOptions): Promise<GetReplicaSetCloudBackup | AtlasError>;
    getAllReplicaSetCloudBackups(clustername: ClusterName, options?: AtlasClientOptions): Promise<GetAllReplicaSetCloudBackups | AtlasError>;
    getSnapshotRestoreJob(clustername: ClusterName, restoreJobId: string, options?: AtlasClientOptions): Promise<CreateSnapshotRestoreJobResponse | AtlasError>
    createSnapshotRestoreJob(clustername: ClusterName, body: SnapshotRestoreJobRequest, options?: AtlasClientOptions): Promise<CreateSnapshotRestoreJobResponse | AtlasError>
}