Package org.yamcs.protobuf
Class InstancesApiClient
@Generated(value="org.yamcs.protoc.ServiceGenerator",
date="2024-04-22T11:12:45.288202214Z")
public class InstancesApiClient
extends AbstractInstancesApi<Void>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
createInstance
(Void ctx, CreateInstanceRequest request, Observer<YamcsInstance> observer) Create an instancefinal void
getInstance
(Void ctx, GetInstanceRequest request, Observer<YamcsInstance> 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.final void
getInstanceTemplate
(Void ctx, GetInstanceTemplateRequest request, Observer<InstanceTemplate> observer) Get an instance templatefinal void
listInstances
(Void ctx, ListInstancesRequest request, Observer<ListInstancesResponse> observer) List instancesfinal void
listInstanceTemplates
(Void ctx, com.google.protobuf.Empty request, Observer<ListInstanceTemplatesResponse> observer) List instance templatesfinal void
reconfigureInstance
(Void ctx, ReconfigureInstanceRequest request, Observer<YamcsInstance> observer) Reconfigure a templated instance Regenerates the instance configuration based on the latest template source, and with optionally modified template variables.final void
restartInstance
(Void ctx, RestartInstanceRequest request, Observer<YamcsInstance> observer) Restart an instance If the instance state is RUNNING, the instance will be stopped and then restarted.final void
startInstance
(Void ctx, StartInstanceRequest request, Observer<YamcsInstance> observer) Start an instance If the instance is in the RUNNING state, this call will do nothing.final void
stopInstance
(Void ctx, StopInstanceRequest request, Observer<YamcsInstance> observer) Stop an instance Stop all services of the instance.final void
subscribeInstances
(Void ctx, com.google.protobuf.Empty request, Observer<YamcsInstance> observer) Receive instance updatesMethods inherited from class org.yamcs.protobuf.AbstractInstancesApi
callMethod, callMethod, getDescriptorForType, getRequestPrototype, getResponsePrototype
-
Constructor Details
-
InstancesApiClient
-
-
Method Details
-
listInstanceTemplates
public final void listInstanceTemplates(Void ctx, com.google.protobuf.Empty request, Observer<ListInstanceTemplatesResponse> observer) List instance templates
- Specified by:
listInstanceTemplates
in classAbstractInstancesApi<Void>
-
getInstanceTemplate
public final void getInstanceTemplate(Void ctx, GetInstanceTemplateRequest request, Observer<InstanceTemplate> observer) Get an instance template
- Specified by:
getInstanceTemplate
in classAbstractInstancesApi<Void>
-
listInstances
public final void listInstances(Void ctx, ListInstancesRequest request, Observer<ListInstancesResponse> observer) List instances
- Specified by:
listInstances
in classAbstractInstancesApi<Void>
-
subscribeInstances
public final void subscribeInstances(Void ctx, com.google.protobuf.Empty request, Observer<YamcsInstance> observer) Receive instance updates
- Specified by:
subscribeInstances
in classAbstractInstancesApi<Void>
-
getInstance
public final void getInstance(Void ctx, GetInstanceRequest request, Observer<YamcsInstance> 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.
- Specified by:
getInstance
in classAbstractInstancesApi<Void>
-
createInstance
public final void createInstance(Void ctx, CreateInstanceRequest request, Observer<YamcsInstance> observer) Create an instance
- Specified by:
createInstance
in classAbstractInstancesApi<Void>
-
reconfigureInstance
public final void reconfigureInstance(Void ctx, ReconfigureInstanceRequest request, Observer<YamcsInstance> observer) Reconfigure a templated instance Regenerates the instance configuration based on the latest template source, and with optionally modified template variables.
- Specified by:
reconfigureInstance
in classAbstractInstancesApi<Void>
-
startInstance
public final void startInstance(Void ctx, StartInstanceRequest request, Observer<YamcsInstance> observer) Start an instance If the instance is in the RUNNING state, this call will do nothing. Otherwise the instance will be started.
- Specified by:
startInstance
in classAbstractInstancesApi<Void>
-
stopInstance
public final void stopInstance(Void ctx, StopInstanceRequest request, Observer<YamcsInstance> 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.
- Specified by:
stopInstance
in classAbstractInstancesApi<Void>
-
restartInstance
public final void restartInstance(Void ctx, RestartInstanceRequest request, Observer<YamcsInstance> 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.
- Specified by:
restartInstance
in classAbstractInstancesApi<Void>
-