org.yamcs.protobuf

Class Web.ParameterSubscriptionRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

org.yamcs.protobuf.Web.ParameterSubscriptionRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Web.ParameterSubscriptionRequestOrBuilder

Enclosing class:

Web.ParameterSubscriptionRequest

public static final class Web.ParameterSubscriptionRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>
implements Web.ParameterSubscriptionRequestOrBuilder

 Used for parameter subscription and unsubscription.
 

Protobuf type yamcs.protobuf.web.ParameterSubscriptionRequest

Method Summary

Modifier and Type	Method and Description
Web.ParameterSubscriptionRequest.Builder	addAllId(Iterable<? extends Yamcs.NamedObjectId> values) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	addId(int index, Yamcs.NamedObjectId.Builder builderForValue) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	addId(int index, Yamcs.NamedObjectId value) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	addId(Yamcs.NamedObjectId.Builder builderForValue) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	addId(Yamcs.NamedObjectId value) repeated .yamcs.protobuf.NamedObjectId id = 1;
Yamcs.NamedObjectId.Builder	addIdBuilder() repeated .yamcs.protobuf.NamedObjectId id = 1;
Yamcs.NamedObjectId.Builder	addIdBuilder(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Web.ParameterSubscriptionRequest	build()
Web.ParameterSubscriptionRequest	buildPartial()
Web.ParameterSubscriptionRequest.Builder	clear()
Web.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
Web.ParameterSubscriptionRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Web.ParameterSubscriptionRequest.Builder	clearId() repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Web.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
Web.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
Web.ParameterSubscriptionRequest.Builder	clearUpdateOnExpiration() if set to true, send parameter updates when parameters expire.
Web.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
Web.ParameterSubscriptionRequest.Builder	clone()
boolean	getAbortOnInvalid() if set to true, an error message will be sent back if any parameter from the list above is invalid by default is false
Web.ParameterSubscriptionRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Yamcs.NamedObjectId	getId(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
Yamcs.NamedObjectId.Builder	getIdBuilder(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
List<Yamcs.NamedObjectId.Builder>	getIdBuilderList() repeated .yamcs.protobuf.NamedObjectId id = 1;
int	getIdCount() repeated .yamcs.protobuf.NamedObjectId id = 1;
List<Yamcs.NamedObjectId>	getIdList() repeated .yamcs.protobuf.NamedObjectId id = 1;
Yamcs.NamedObjectIdOrBuilder	getIdOrBuilder(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
List<? extends Yamcs.NamedObjectIdOrBuilder>	getIdOrBuilderList() repeated .yamcs.protobuf.NamedObjectId id = 1;
boolean	getSendFromCache() 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
int	getSubscriptionId() 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
boolean	getUpdateOnExpiration() if set to true, send parameter updates when parameters expire.
boolean	getUseNumericIds() 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
boolean	hasAbortOnInvalid() if set to true, an error message will be sent back if any parameter from the list above is invalid by default is false
boolean	hasSendFromCache() 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
boolean	hasSubscriptionId() 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
boolean	hasUpdateOnExpiration() if set to true, send parameter updates when parameters expire.
boolean	hasUseNumericIds() 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
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Web.ParameterSubscriptionRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Web.ParameterSubscriptionRequest.Builder	mergeFrom(com.google.protobuf.Message other)
Web.ParameterSubscriptionRequest.Builder	mergeFrom(Web.ParameterSubscriptionRequest other)
Web.ParameterSubscriptionRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Web.ParameterSubscriptionRequest.Builder	removeId(int index) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.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
Web.ParameterSubscriptionRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Web.ParameterSubscriptionRequest.Builder	setId(int index, Yamcs.NamedObjectId.Builder builderForValue) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	setId(int index, Yamcs.NamedObjectId value) repeated .yamcs.protobuf.NamedObjectId id = 1;
Web.ParameterSubscriptionRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Web.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
Web.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
Web.ParameterSubscriptionRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Web.ParameterSubscriptionRequest.Builder	setUpdateOnExpiration(boolean value) if set to true, send parameter updates when parameters expire.
Web.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

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

clear

public Web.ParameterSubscriptionRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

getDefaultInstanceForType

public Web.ParameterSubscriptionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Web.ParameterSubscriptionRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Web.ParameterSubscriptionRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Web.ParameterSubscriptionRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

setField

public Web.ParameterSubscriptionRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

clearField

public Web.ParameterSubscriptionRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

clearOneof

public Web.ParameterSubscriptionRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

setRepeatedField

public Web.ParameterSubscriptionRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 int index,
                                                                 Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

addRepeatedField

public Web.ParameterSubscriptionRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                 Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

mergeFrom

public Web.ParameterSubscriptionRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Web.ParameterSubscriptionRequest.Builder>

mergeFrom

public Web.ParameterSubscriptionRequest.Builder mergeFrom(Web.ParameterSubscriptionRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

mergeFrom

public Web.ParameterSubscriptionRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Web.ParameterSubscriptionRequest.Builder>

Throws:

IOException

getIdList

public List<Yamcs.NamedObjectId> getIdList()

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdList in interface Web.ParameterSubscriptionRequestOrBuilder

getIdCount

public int getIdCount()

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdCount in interface Web.ParameterSubscriptionRequestOrBuilder

getId

public Yamcs.NamedObjectId getId(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getId in interface Web.ParameterSubscriptionRequestOrBuilder

setId

public Web.ParameterSubscriptionRequest.Builder setId(int index,
                                                      Yamcs.NamedObjectId value)

repeated .yamcs.protobuf.NamedObjectId id = 1;

setId

public Web.ParameterSubscriptionRequest.Builder setId(int index,
                                                      Yamcs.NamedObjectId.Builder builderForValue)

repeated .yamcs.protobuf.NamedObjectId id = 1;

addId

public Web.ParameterSubscriptionRequest.Builder addId(Yamcs.NamedObjectId value)

repeated .yamcs.protobuf.NamedObjectId id = 1;

addId

public Web.ParameterSubscriptionRequest.Builder addId(int index,
                                                      Yamcs.NamedObjectId value)

repeated .yamcs.protobuf.NamedObjectId id = 1;

addId

public Web.ParameterSubscriptionRequest.Builder addId(Yamcs.NamedObjectId.Builder builderForValue)

repeated .yamcs.protobuf.NamedObjectId id = 1;

addId

public Web.ParameterSubscriptionRequest.Builder addId(int index,
                                                      Yamcs.NamedObjectId.Builder builderForValue)

repeated .yamcs.protobuf.NamedObjectId id = 1;

addAllId

public Web.ParameterSubscriptionRequest.Builder addAllId(Iterable<? extends Yamcs.NamedObjectId> values)

repeated .yamcs.protobuf.NamedObjectId id = 1;

clearId

public Web.ParameterSubscriptionRequest.Builder clearId()

repeated .yamcs.protobuf.NamedObjectId id = 1;

removeId

public Web.ParameterSubscriptionRequest.Builder removeId(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

getIdBuilder

public Yamcs.NamedObjectId.Builder getIdBuilder(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

getIdOrBuilder

public Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdOrBuilder in interface Web.ParameterSubscriptionRequestOrBuilder

getIdOrBuilderList

public List<? extends Yamcs.NamedObjectIdOrBuilder> getIdOrBuilderList()

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdOrBuilderList in interface Web.ParameterSubscriptionRequestOrBuilder

addIdBuilder

public Yamcs.NamedObjectId.Builder addIdBuilder()

repeated .yamcs.protobuf.NamedObjectId id = 1;

addIdBuilder

public Yamcs.NamedObjectId.Builder addIdBuilder(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

getIdBuilderList

public List<Yamcs.NamedObjectId.Builder> getIdBuilderList()

repeated .yamcs.protobuf.NamedObjectId id = 1;

hasAbortOnInvalid

public boolean hasAbortOnInvalid()

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;

Specified by:

hasAbortOnInvalid in interface Web.ParameterSubscriptionRequestOrBuilder

getAbortOnInvalid

public boolean getAbortOnInvalid()

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;

Specified by:

getAbortOnInvalid in interface Web.ParameterSubscriptionRequestOrBuilder

setAbortOnInvalid

public Web.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;

clearAbortOnInvalid

public Web.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;

hasUpdateOnExpiration

public boolean hasUpdateOnExpiration()

 if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
 

optional bool updateOnExpiration = 3;

Specified by:

hasUpdateOnExpiration in interface Web.ParameterSubscriptionRequestOrBuilder

getUpdateOnExpiration

public boolean getUpdateOnExpiration()

 if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
 

optional bool updateOnExpiration = 3;

Specified by:

getUpdateOnExpiration in interface Web.ParameterSubscriptionRequestOrBuilder

setUpdateOnExpiration

public Web.ParameterSubscriptionRequest.Builder setUpdateOnExpiration(boolean value)

 if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
 

optional bool updateOnExpiration = 3;

clearUpdateOnExpiration

public Web.ParameterSubscriptionRequest.Builder clearUpdateOnExpiration()

 if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
 

optional bool updateOnExpiration = 3;

hasSendFromCache

public boolean hasSendFromCache()

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;

Specified by:

hasSendFromCache in interface Web.ParameterSubscriptionRequestOrBuilder

getSendFromCache

public boolean getSendFromCache()

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;

Specified by:

getSendFromCache in interface Web.ParameterSubscriptionRequestOrBuilder

setSendFromCache

public Web.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;

clearSendFromCache

public Web.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;

hasSubscriptionId

public boolean hasSubscriptionId()

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;

Specified by:

hasSubscriptionId in interface Web.ParameterSubscriptionRequestOrBuilder

getSubscriptionId

public int getSubscriptionId()

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;

Specified by:

getSubscriptionId in interface Web.ParameterSubscriptionRequestOrBuilder

setSubscriptionId

public Web.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;

clearSubscriptionId

public Web.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;

hasUseNumericIds

public boolean hasUseNumericIds()

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;

Specified by:

hasUseNumericIds in interface Web.ParameterSubscriptionRequestOrBuilder

getUseNumericIds

public boolean getUseNumericIds()

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;

Specified by:

getUseNumericIds in interface Web.ParameterSubscriptionRequestOrBuilder

setUseNumericIds

public Web.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;

clearUseNumericIds

public Web.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;

setUnknownFields

public final Web.ParameterSubscriptionRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>

mergeUnknownFields

public final Web.ParameterSubscriptionRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Web.ParameterSubscriptionRequest.Builder>