@nebius/js-sdk - v0.2.54
    Preparing search index...

    Interface ClusterServiceBaseClient

    Defines the low-level gRPC client for the nebius.msp.postgresql.v1alpha1.ClusterService service.

    interface ClusterServiceBaseClient {
        create(
            request: CreateClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        delete(
            request: DeleteClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        get(
            request: GetClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Cluster) => void,
        ): SurfaceCall;
        getByName(
            request: GetByNameRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Cluster) => void,
        ): SurfaceCall;
        getForBackup(
            request: GetClusterForBackupRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Cluster) => void,
        ): SurfaceCall;
        list(
            request: ListClustersRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListClustersResponse,
            ) => void,
        ): SurfaceCall;
        restore(
            request: RestoreClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        start(
            request: StartClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        stop(
            request: StopClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        update(
            request: UpdateClusterRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
    }

    Hierarchy

    • Client
      • ClusterServiceBaseClient
    Index
    create delete get getByName getForBackup list restore start stop update

    • Creates a PostgreSQL cluster in the specified folder.

      Parameters

      • request: CreateClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Creates a PostgreSQL cluster in the specified folder.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Deletes the specified PostgreSQL cluster.

      Parameters

      • request: DeleteClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Deletes the specified PostgreSQL cluster.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

      Parameters

      • request: GetClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Cluster) => void
          • (error: ServiceError | null, response: Cluster): void

          • Returns the specified PostgreSQL Cluster resource. To get the list of available PostgreSQL Cluster resources, make a [List] request.

            Parameters

            • error: ServiceError | null
            • response: Cluster

            Returns void

      Returns SurfaceCall

    • Returns the specified PostgreSQL Cluster resource by name.

      Parameters

      • request: GetByNameRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Cluster) => void
          • (error: ServiceError | null, response: Cluster): void

          • Returns the specified PostgreSQL Cluster resource by name.

            Parameters

            • error: ServiceError | null
            • response: Cluster

            Returns void

      Returns SurfaceCall

    • Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

      Parameters

      • request: GetClusterForBackupRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Cluster) => void
          • (error: ServiceError | null, response: Cluster): void

          • Returns the specified PostgreSQL Cluster resource for backup. It should be used as a hint of cluster configuration in case of backup restoration.

            Parameters

            • error: ServiceError | null
            • response: Cluster

            Returns void

      Returns SurfaceCall

    • Retrieves the list of PostgreSQL Cluster resources that belong to the specified folder.

      Parameters

      Returns SurfaceCall

    • Creates a new PostgreSQL cluster from a previously created backup.

      Parameters

      • request: RestoreClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Creates a new PostgreSQL cluster from a previously created backup.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Wakes up suspended PostgreSQL cluster.

      Parameters

      • request: StartClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Wakes up suspended PostgreSQL cluster.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Suspends the PostgreSQL cluster to save resources.

      Parameters

      • request: StopClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Suspends the PostgreSQL cluster to save resources.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Updates the PostgreSQL cluster.

      Parameters

      • request: UpdateClusterRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Updates the PostgreSQL cluster.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    Settings
    Member Visibility

    On This Page
    Methods