org.yamcs.protobuf.FileTransferApiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
package org.yamcs.protobuf;

import com.google.protobuf.Empty;
import com.google.protobuf.Struct;
import org.yamcs.api.MethodHandler;
import org.yamcs.api.Observer;

@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.907310109Z")
public class FileTransferApiClient extends AbstractFileTransferApi {

    private final MethodHandler handler;

    public FileTransferApiClient(MethodHandler handler) {
        this.handler = handler;
    }

    /**
     *      *  List file transfer services
     * 
     */
    @Override
    public final void listFileTransferServices(Void ctx, ListFileTransferServicesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            ListFileTransferServicesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a file transfer service
     * 
     */
    @Override
    public final void getFileTransferService(Void ctx, GetFileTransferServiceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            FileTransferServiceInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List transfers
     * 
     */
    @Override
    public final void listTransfers(Void ctx, ListTransfersRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            ListTransfersResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get a transfer
     * 
     */
    @Override
    public final void getTransfer(Void ctx, GetTransferRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            TransferInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Create a transfer
     * 
     */
    @Override
    public final void createTransfer(Void ctx, CreateTransferRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            TransferInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Pause a transfer
     * 
     */
    @Override
    public final void pauseTransfer(Void ctx, PauseTransferRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Cancel a transfer
     * 
     *  The ongoing transfer is aborted, partially uploaded/downloaded files
     *  are retained.
     * 
     */
    @Override
    public final void cancelTransfer(Void ctx, CancelTransferRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(6),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Resume a transfer
     * 
     */
    @Override
    public final void resumeTransfer(Void ctx, ResumeTransferRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(7),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Subscribe to transfer updates
     * 
     */
    @Override
    public final void subscribeTransfers(Void ctx, SubscribeTransfersRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(8),
            request,
            TransferInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Subscribe to remote file list updates
     * 
     */
    @Override
    public final void subscribeRemoteFileList(Void ctx, SubscribeTransfersRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(9),
            request,
            ListFilesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Request file list from remote
     * 
     */
    @Override
    public final void fetchFileList(Void ctx, ListFilesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(10),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get latest file list
     * 
     */
    @Override
    public final void getFileList(Void ctx, ListFilesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(11),
            request,
            ListFilesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Run a file-specific action.
     * 
     *  Available actions are specific to the File Transfer implementation.
     * 
     */
    @Override
    public final void runFileAction(Void ctx, RunFileActionRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(12),
            request,
            Struct.getDefaultInstance(),
            observer);
    }
}