| Package | Description |
|---|---|
| org.yamcs.protobuf |
| Modifier and Type | Method and Description |
|---|---|
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.addAllId(Iterable<? extends Yamcs.NamedObjectId> values)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.addId(int index,
Yamcs.NamedObjectId.Builder builderForValue)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.addId(int index,
Yamcs.NamedObjectId value)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.addId(Yamcs.NamedObjectId.Builder builderForValue)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.addId(Yamcs.NamedObjectId value)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clear() |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearAbortOnInvalid()
if set to true, an error message will be sent back if any parameter from the list above is invalid
by default is false
optional bool abortOnInvalid = 2; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearId()
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearSendFromCache()
if set to true (default), send a first batch of the parameters from cache if available
otherwise just wait for the parameters to be updated
optional bool sendFromCache = 4; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearSubscriptionId()
subcriptionId
0 or not specified means to add parameters to the first subscription made
this is for compatibility with the previous yamcs version before 4.1
when it was not possible to have multiple subscriptions
-1 means to create a new subscription
>1 means to add parameters to the existing subcription with that id
optional int32 subscriptionId = 5; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearUpdateOnExpiration()
if set to true, send parameter updates when parameters expire.
|
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clearUseNumericIds()
if set to true (higly recommended), a uint32 numeric id will be assigned to each parameter and will be sent back together with the value (instead of the NamedObjectId)
this is done in order to reduce the bandwith used for transfering the parameter identifiers (since the NamedObjectId are quite long)
Note that the numeric id is only unique on the websocket connection
the ParameterSubscriptionResponse will contain the mapping id to NamedObjectId
optional bool useNumericIds = 6; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.clone() |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.mergeFrom(com.google.protobuf.Message other) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.mergeFrom(ParameterSubscriptionRequest other) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
static ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.newBuilder() |
static ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.newBuilder(ParameterSubscriptionRequest prototype) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.newBuilderForType() |
protected ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.removeId(int index)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setAbortOnInvalid(boolean value)
if set to true, an error message will be sent back if any parameter from the list above is invalid
by default is false
optional bool abortOnInvalid = 2; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setId(int index,
Yamcs.NamedObjectId.Builder builderForValue)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setId(int index,
Yamcs.NamedObjectId value)
repeated .yamcs.protobuf.NamedObjectId id = 1; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setSendFromCache(boolean value)
if set to true (default), send a first batch of the parameters from cache if available
otherwise just wait for the parameters to be updated
optional bool sendFromCache = 4; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setSubscriptionId(int value)
subcriptionId
0 or not specified means to add parameters to the first subscription made
this is for compatibility with the previous yamcs version before 4.1
when it was not possible to have multiple subscriptions
-1 means to create a new subscription
>1 means to add parameters to the existing subcription with that id
optional int32 subscriptionId = 5; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setUpdateOnExpiration(boolean value)
if set to true, send parameter updates when parameters expire.
|
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.Builder.setUseNumericIds(boolean value)
if set to true (higly recommended), a uint32 numeric id will be assigned to each parameter and will be sent back together with the value (instead of the NamedObjectId)
this is done in order to reduce the bandwith used for transfering the parameter identifiers (since the NamedObjectId are quite long)
Note that the numeric id is only unique on the websocket connection
the ParameterSubscriptionResponse will contain the mapping id to NamedObjectId
optional bool useNumericIds = 6; |
ParameterSubscriptionRequest.Builder |
ParameterSubscriptionRequest.toBuilder() |
Copyright © 2022 Space Applications Services. All rights reserved.