org.yamcs.protobuf.InstancesApiClient 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;

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

    private final MethodHandler handler;

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

    /**
     *      *  List instance templates
     * 
     */
    @Override
    public final void listInstanceTemplates(Void ctx, Empty request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            ListInstanceTemplatesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get an instance template
     * 
     */
    @Override
    public final void getInstanceTemplate(Void ctx, GetInstanceTemplateRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            InstanceTemplate.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List instances
     * 
     */
    @Override
    public final void listInstances(Void ctx, ListInstancesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            ListInstancesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Receive instance updates
     * 
     */
    @Override
    public final void subscribeInstances(Void ctx, Empty request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Get an instance
     *  
     *  If an instance does not have web services enabled, it will be listed among the
     *  results, but none of its URLs will be filled in.
     * 
     */
    @Override
    public final void getInstance(Void ctx, GetInstanceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Create an instance
     * 
     */
    @Override
    public final void createInstance(Void ctx, CreateInstanceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(5),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Reconfigure a templated instance
     * 
     *  Regenerates the instance configuration based on the latest
     *  template source, and with optionally modified template variables.
     * 
     */
    @Override
    public final void reconfigureInstance(Void ctx, ReconfigureInstanceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(6),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Start an instance
     * 
     *  If the instance is in the RUNNING state, this call will do nothing.
     *  Otherwise the instance will be started.
     * 
     */
    @Override
    public final void startInstance(Void ctx, StartInstanceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(7),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Stop an instance
     *  
     *  Stop all services of the instance. The instance state will be OFFLINE.
     *  If the instance state is already OFFLINE, this call will do nothing.
     * 
     */
    @Override
    public final void stopInstance(Void ctx, StopInstanceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(8),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Restart an instance
     * 
     *  If the instance state is RUNNING, the instance will be stopped and then
     *  restarted. Otherwise the instance will be started. Note that the Mission
     *  Database will also be reloaded before restart.
     * 
     */
    @Override
    public final void restartInstance(Void ctx, RestartInstanceRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(9),
            request,
            YamcsInstance.getDefaultInstance(),
            observer);
    }
}