org.yamcs.protobuf.AbstractFileTransferApi 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.Descriptors.MethodDescriptor;
import com.google.protobuf.Descriptors.ServiceDescriptor;
import com.google.protobuf.Empty;
import com.google.protobuf.Message;
import com.google.protobuf.Struct;
import org.yamcs.api.Api;
import org.yamcs.api.Observer;

@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.907110854Z")
@SuppressWarnings("unchecked")
public abstract class AbstractFileTransferApi implements Api {

    /**
     *      *  List file transfer services
     * 
     */
    public abstract void listFileTransferServices(T ctx, ListFileTransferServicesRequest request, Observer observer);

    /**
     *      *  Get a file transfer service
     * 
     */
    public abstract void getFileTransferService(T ctx, GetFileTransferServiceRequest request, Observer observer);

    /**
     *      *  List transfers
     * 
     */
    public abstract void listTransfers(T ctx, ListTransfersRequest request, Observer observer);

    /**
     *      *  Get a transfer
     * 
     */
    public abstract void getTransfer(T ctx, GetTransferRequest request, Observer observer);

    /**
     *      *  Create a transfer
     * 
     */
    public abstract void createTransfer(T ctx, CreateTransferRequest request, Observer observer);

    /**
     *      *  Pause a transfer
     * 
     */
    public abstract void pauseTransfer(T ctx, PauseTransferRequest request, Observer observer);

    /**
     *      *  Cancel a transfer
     * 
     *  The ongoing transfer is aborted, partially uploaded/downloaded files
     *  are retained.
     * 
     */
    public abstract void cancelTransfer(T ctx, CancelTransferRequest request, Observer observer);

    /**
     *      *  Resume a transfer
     * 
     */
    public abstract void resumeTransfer(T ctx, ResumeTransferRequest request, Observer observer);

    /**
     *      *  Subscribe to transfer updates
     * 
     */
    public abstract void subscribeTransfers(T ctx, SubscribeTransfersRequest request, Observer observer);

    /**
     *      *  Subscribe to remote file list updates
     * 
     */
    public abstract void subscribeRemoteFileList(T ctx, SubscribeTransfersRequest request, Observer observer);

    /**
     *      *  Request file list from remote
     * 
     */
    public abstract void fetchFileList(T ctx, ListFilesRequest request, Observer observer);

    /**
     *      *  Get latest file list
     * 
     */
    public abstract void getFileList(T ctx, ListFilesRequest request, Observer observer);

    /**
     *      *  Run a file-specific action.
     * 
     *  Available actions are specific to the File Transfer implementation.
     * 
     */
    public abstract void runFileAction(T ctx, RunFileActionRequest request, Observer observer);

    @Override
    public final ServiceDescriptor getDescriptorForType() {
        return FileTransferProto.getDescriptor().getServices().get(0);
    }

    @Override
    public final Message getRequestPrototype(MethodDescriptor method) {
        if (method.getService() != getDescriptorForType()) {
            throw new IllegalArgumentException("Method not contained by this service.");
        }
        switch (method.getIndex()) {
        case 0:
            return ListFileTransferServicesRequest.getDefaultInstance();
        case 1:
            return GetFileTransferServiceRequest.getDefaultInstance();
        case 2:
            return ListTransfersRequest.getDefaultInstance();
        case 3:
            return GetTransferRequest.getDefaultInstance();
        case 4:
            return CreateTransferRequest.getDefaultInstance();
        case 5:
            return PauseTransferRequest.getDefaultInstance();
        case 6:
            return CancelTransferRequest.getDefaultInstance();
        case 7:
            return ResumeTransferRequest.getDefaultInstance();
        case 8:
            return SubscribeTransfersRequest.getDefaultInstance();
        case 9:
            return SubscribeTransfersRequest.getDefaultInstance();
        case 10:
            return ListFilesRequest.getDefaultInstance();
        case 11:
            return ListFilesRequest.getDefaultInstance();
        case 12:
            return RunFileActionRequest.getDefaultInstance();
        default:
            throw new IllegalStateException();
        }
    }

    @Override
    public final Message getResponsePrototype(MethodDescriptor method) {
        if (method.getService() != getDescriptorForType()) {
            throw new IllegalArgumentException("Method not contained by this service.");
        }
        switch (method.getIndex()) {
        case 0:
            return ListFileTransferServicesResponse.getDefaultInstance();
        case 1:
            return FileTransferServiceInfo.getDefaultInstance();
        case 2:
            return ListTransfersResponse.getDefaultInstance();
        case 3:
            return TransferInfo.getDefaultInstance();
        case 4:
            return TransferInfo.getDefaultInstance();
        case 5:
            return Empty.getDefaultInstance();
        case 6:
            return Empty.getDefaultInstance();
        case 7:
            return Empty.getDefaultInstance();
        case 8:
            return TransferInfo.getDefaultInstance();
        case 9:
            return ListFilesResponse.getDefaultInstance();
        case 10:
            return Empty.getDefaultInstance();
        case 11:
            return ListFilesResponse.getDefaultInstance();
        case 12:
            return Struct.getDefaultInstance();
        default:
            throw new IllegalStateException();
        }
    }

    @Override
    public final void callMethod(MethodDescriptor method, T ctx, Message request, Observer future) {
        if (method.getService() != getDescriptorForType()) {
            throw new IllegalArgumentException("Method not contained by this service.");
        }
        switch (method.getIndex()) {
        case 0:
            listFileTransferServices(ctx, (ListFileTransferServicesRequest) request, (Observer)(Object) future);
            return;
        case 1:
            getFileTransferService(ctx, (GetFileTransferServiceRequest) request, (Observer)(Object) future);
            return;
        case 2:
            listTransfers(ctx, (ListTransfersRequest) request, (Observer)(Object) future);
            return;
        case 3:
            getTransfer(ctx, (GetTransferRequest) request, (Observer)(Object) future);
            return;
        case 4:
            createTransfer(ctx, (CreateTransferRequest) request, (Observer)(Object) future);
            return;
        case 5:
            pauseTransfer(ctx, (PauseTransferRequest) request, (Observer)(Object) future);
            return;
        case 6:
            cancelTransfer(ctx, (CancelTransferRequest) request, (Observer)(Object) future);
            return;
        case 7:
            resumeTransfer(ctx, (ResumeTransferRequest) request, (Observer)(Object) future);
            return;
        case 8:
            subscribeTransfers(ctx, (SubscribeTransfersRequest) request, (Observer)(Object) future);
            return;
        case 9:
            subscribeRemoteFileList(ctx, (SubscribeTransfersRequest) request, (Observer)(Object) future);
            return;
        case 10:
            fetchFileList(ctx, (ListFilesRequest) request, (Observer)(Object) future);
            return;
        case 11:
            getFileList(ctx, (ListFilesRequest) request, (Observer)(Object) future);
            return;
        case 12:
            runFileAction(ctx, (RunFileActionRequest) request, (Observer)(Object) future);
            return;
        default:
            throw new IllegalStateException();
        }
    }

    @Override
    public final Observer callMethod(MethodDescriptor method, T ctx, Observer future) {
        if (method.getService() != getDescriptorForType()) {
            throw new IllegalArgumentException("Method not contained by this service.");
        }
        switch (method.getIndex()) {
        default:
            throw new IllegalStateException();
        }
    }
}