org.yamcs.protobuf

Class ParameterSubscriptionRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.yamcs.protobuf.ParameterSubscriptionRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ParameterSubscriptionRequestOrBuilder

public final class ParameterSubscriptionRequest
extends com.google.protobuf.GeneratedMessageV3
implements ParameterSubscriptionRequestOrBuilder

 Used for parameter subscription and unsubscription.
 

Protobuf type yamcs.protobuf.web.ParameterSubscriptionRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterSubscriptionRequest.Builder Used for parameter subscription and unsubscription.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ABORTONINVALID_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static com.google.protobuf.Parser<ParameterSubscriptionRequest>	PARSER Deprecated.
static int	SENDFROMCACHE_FIELD_NUMBER
static int	SUBSCRIPTIONID_FIELD_NUMBER
static int	UPDATEONEXPIRATION_FIELD_NUMBER
static int	USENUMERICIDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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;
static ParameterSubscriptionRequest	getDefaultInstance()
ParameterSubscriptionRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Yamcs.NamedObjectId	getId(int index) 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;
com.google.protobuf.Parser<ParameterSubscriptionRequest>	getParserForType()
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;
int	getSerializedSize()
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;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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 optional bool useNumericIds = 6;
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;
int	hashCode()
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;
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;
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 optional bool useNumericIds = 6;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ParameterSubscriptionRequest.Builder	newBuilder()
static ParameterSubscriptionRequest.Builder	newBuilder(ParameterSubscriptionRequest prototype)
ParameterSubscriptionRequest.Builder	newBuilderForType()
protected ParameterSubscriptionRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static ParameterSubscriptionRequest	parseDelimitedFrom(InputStream input)
static ParameterSubscriptionRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterSubscriptionRequest	parseFrom(byte[] data)
static ParameterSubscriptionRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterSubscriptionRequest	parseFrom(ByteBuffer data)
static ParameterSubscriptionRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterSubscriptionRequest	parseFrom(com.google.protobuf.ByteString data)
static ParameterSubscriptionRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterSubscriptionRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static ParameterSubscriptionRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ParameterSubscriptionRequest	parseFrom(InputStream input)
static ParameterSubscriptionRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ParameterSubscriptionRequest>	parser()
ParameterSubscriptionRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

ABORTONINVALID_FIELD_NUMBER

public static final int ABORTONINVALID_FIELD_NUMBER

See Also:

Constant Field Values

UPDATEONEXPIRATION_FIELD_NUMBER

public static final int UPDATEONEXPIRATION_FIELD_NUMBER

See Also:

Constant Field Values

SENDFROMCACHE_FIELD_NUMBER

public static final int SENDFROMCACHE_FIELD_NUMBER

See Also:

Constant Field Values

SUBSCRIPTIONID_FIELD_NUMBER

public static final int SUBSCRIPTIONID_FIELD_NUMBER

See Also:

Constant Field Values

USENUMERICIDS_FIELD_NUMBER

public static final int USENUMERICIDS_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<ParameterSubscriptionRequest> PARSER

Deprecated.

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getIdList

public List<Yamcs.NamedObjectId> getIdList()

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdList in interface ParameterSubscriptionRequestOrBuilder

getIdOrBuilderList

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

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdOrBuilderList in interface ParameterSubscriptionRequestOrBuilder

getIdCount

public int getIdCount()

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdCount in interface ParameterSubscriptionRequestOrBuilder

getId

public Yamcs.NamedObjectId getId(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getId in interface ParameterSubscriptionRequestOrBuilder

getIdOrBuilder

public Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)

repeated .yamcs.protobuf.NamedObjectId id = 1;

Specified by:

getIdOrBuilder in interface ParameterSubscriptionRequestOrBuilder

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 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 ParameterSubscriptionRequestOrBuilder

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 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 ParameterSubscriptionRequestOrBuilder

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 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 ParameterSubscriptionRequestOrBuilder

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 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 ParameterSubscriptionRequestOrBuilder

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 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 ParameterSubscriptionRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ParameterSubscriptionRequest parseFrom(ByteBuffer data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ParameterSubscriptionRequest parseFrom(ByteBuffer data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ParameterSubscriptionRequest parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ParameterSubscriptionRequest parseFrom(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ParameterSubscriptionRequest parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ParameterSubscriptionRequest parseFrom(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ParameterSubscriptionRequest parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static ParameterSubscriptionRequest parseFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static ParameterSubscriptionRequest parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static ParameterSubscriptionRequest parseDelimitedFrom(InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static ParameterSubscriptionRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static ParameterSubscriptionRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

newBuilderForType

public ParameterSubscriptionRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ParameterSubscriptionRequest.Builder newBuilder()

newBuilder

public static ParameterSubscriptionRequest.Builder newBuilder(ParameterSubscriptionRequest prototype)

toBuilder

public ParameterSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ParameterSubscriptionRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ParameterSubscriptionRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ParameterSubscriptionRequest> parser()

getParserForType

public com.google.protobuf.Parser<ParameterSubscriptionRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ParameterSubscriptionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder