org.yamcs.web.api.WebApiClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-web Show documentation
Web UI for managing and monitoring Yamcs
There is a newer version: 5.10.9
package org.yamcs.web.api;

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:14:06.133134064Z")
public class WebApiClient extends AbstractWebApi {

    private final MethodHandler handler;

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

    /**
     *      *  Get web configuration for an instance
     * 
     */
    @Override
    public final void getInstanceConfiguration(Void ctx, GetInstanceConfigurationRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(0),
            request,
            InstanceConfiguration.getDefaultInstance(),
            observer);
    }

    /**
     *      *  List queries for a resource
     * 
     */
    @Override
    public final void listQueries(Void ctx, ListQueriesRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(1),
            request,
            ListQueriesResponse.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Create a query on a target resource
     * 
     */
    @Override
    public final void createQuery(Void ctx, CreateQueryRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(2),
            request,
            QueryInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Update a query
     * 
     */
    @Override
    public final void updateQuery(Void ctx, UpdateQueryRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(3),
            request,
            QueryInfo.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Delete a query
     * 
     */
    @Override
    public final void deleteQuery(Void ctx, DeleteQueryRequest request, Observer observer) {
        handler.call(
            getDescriptorForType().getMethods().get(4),
            request,
            Empty.getDefaultInstance(),
            observer);
    }

    /**
     *      *  Parses a resource filter query
     * 
     *  This operation was added to assist yamcs-web in using the
     *  server-side implementation to parse query filters, while the
     *  client-side implementation is not sufficiently complete.
     * 
     *  It is modeled as a WebSocket, to avoid an abundance of ignorable
     *  requests and 404 warnings in the server log.
     * 
     */
    @Override
    @SuppressWarnings("unchecked")
    public final Observer parseFilter(Void ctx, Observer observer) {
        return (Observer)(Object) handler.streamingCall(
            getDescriptorForType().getMethods().get(5),
            ParseFilterRequest.getDefaultInstance(),
            ParseFilterData.getDefaultInstance(),
            observer);
    }
}