org.yamcs.protobuf.MdbOverrideApiClient 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 org.yamcs.api.MethodHandler;
import org.yamcs.api.Observer;
import org.yamcs.protobuf.Mdb.ParameterTypeInfo;

/**
 *  *  Groups operations that support runtime changes to some parts of the MDB.
 * 
 *  These changes are always scoped to a processor, and do not persist across
 *  server restarts.
 * 
 */
@javax.annotation.processing.Generated(value = "org.yamcs.maven.ServiceGenerator", date = "2025-02-13T11:12:59.914006621Z")
public class MdbOverrideApiClient extends AbstractMdbOverrideApi {

    private final MethodHandler handler;

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

    /**
     *      *  List MDB overrides
     * 
     */
    @Override
    public final void listMdbOverrides(Void ctx, ListMdbOverridesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            ListMdbOverridesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get overrides for an algorithm
     * 
     */
    @Override
    public final void getAlgorithmOverrides(Void ctx, GetAlgorithmOverridesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            GetAlgorithmOverridesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get elements of a parameter's definition, as changed for a
     *  specific processor.
     * 
     *  This may return empty, if there is no change, or a previous change
     *  was explicitly deleted.
     * 
     */
    @Override
    public final void getParameterOverride(Void ctx, GetParameterOverrideRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            ParameterOverride.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update a parameter's definition
     * 
     */
    @Override
    public final void updateParameter(Void ctx, UpdateParameterRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            ParameterTypeInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update an algorithm's definition
     * 
     */
    @Override
    public final void updateAlgorithm(Void ctx, UpdateAlgorithmRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Receive notifications on processor-level MDB changes.
     * 
     *  Updates include the current state of the algorithm or
     *  parameter, also when an override is essentially removed.
     * 
     */
    @Override
    public final void subscribeMdbChanges(Void ctx, SubscribeMdbChangesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            MdbOverrideInfo.getDefaultInstance(),
            observer);
    }
}