Package org.yamcs.web.api

Class WebApiClient

java.lang.Object

org.yamcs.web.api.AbstractWebApi<Void>

org.yamcs.web.api.WebApiClient

All Implemented Interfaces:

Api<Void>

@Generated(value="org.yamcs.maven.ServiceGenerator",
           date="2025-03-22T11:19:46.451455178Z")
public class WebApiClient
extends AbstractWebApi<Void>

Constructor Summary

Constructors

Constructor	Description
WebApiClient(MethodHandler handler)

Method Summary

Modifier and Type	Method	Description
final void	createQuery(Void ctx, CreateQueryRequest request, Observer<QueryInfo> observer)	Create a query on a target resource
final void	deleteQuery(Void ctx, DeleteQueryRequest request, Observer<com.google.protobuf.Empty> observer)	Delete a query
final void	getInstanceConfiguration(Void ctx, GetInstanceConfigurationRequest request, Observer<InstanceConfiguration> observer)	Get web configuration for an instance
final void	listQueries(Void ctx, ListQueriesRequest request, Observer<ListQueriesResponse> observer)	List queries for a resource
final Observer<ParseFilterRequest>	parseFilter(Void ctx, Observer<ParseFilterData> 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.
final void	updateQuery(Void ctx, UpdateQueryRequest request, Observer<QueryInfo> observer)	Update a query

Methods inherited from class org.yamcs.web.api.AbstractWebApi

callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebApiClient

public WebApiClient(MethodHandler handler)

Method Details

getInstanceConfiguration

public final void getInstanceConfiguration(Void ctx,
 GetInstanceConfigurationRequest request,
 Observer<InstanceConfiguration> observer)

  Get web configuration for an instance
 

Specified by:

getInstanceConfiguration in class AbstractWebApi<Void>

listQueries

public final void listQueries(Void ctx,
 ListQueriesRequest request,
 Observer<ListQueriesResponse> observer)

  List queries for a resource
 

Specified by:

listQueries in class AbstractWebApi<Void>

createQuery

public final void createQuery(Void ctx,
 CreateQueryRequest request,
 Observer<QueryInfo> observer)

  Create a query on a target resource
 

Specified by:

createQuery in class AbstractWebApi<Void>

updateQuery

public final void updateQuery(Void ctx,
 UpdateQueryRequest request,
 Observer<QueryInfo> observer)

  Update a query
 

Specified by:

updateQuery in class AbstractWebApi<Void>

deleteQuery

public final void deleteQuery(Void ctx,
 DeleteQueryRequest request,
 Observer<com.google.protobuf.Empty> observer)

  Delete a query
 

Specified by:

deleteQuery in class AbstractWebApi<Void>

parseFilter

public final Observer<ParseFilterRequest> parseFilter(Void ctx,
 Observer<ParseFilterData> 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.
 

Specified by:

parseFilter in class AbstractWebApi<Void>