org.yamcs.protobuf

Class Web.ParameterSubscriptionRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.yamcs.protobuf.Web.ParameterSubscriptionRequest

All Implemented Interfaces:

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

Enclosing class:

Web

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

 Used for parameter subscription and unsubscription.
 

Protobuf type web.ParameterSubscriptionRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Web.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 int	LIST_FIELD_NUMBER
static com.google.protobuf.Parser<Web.ParameterSubscriptionRequest>	PARSER Deprecated.
static int	SENDFROMCACHE_FIELD_NUMBER
static int	SUBSCRIPTIONID_FIELD_NUMBER
static int	UPDATEONEXPIRATION_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
static Web.ParameterSubscriptionRequest	getDefaultInstance()
Web.ParameterSubscriptionRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Yamcs.NamedObjectId	getId(int index) repeated .yamcs.NamedObjectId id = 1;
int	getIdCount() repeated .yamcs.NamedObjectId id = 1;
List<Yamcs.NamedObjectId>	getIdList() repeated .yamcs.NamedObjectId id = 1;
Yamcs.NamedObjectIdOrBuilder	getIdOrBuilder(int index) repeated .yamcs.NamedObjectId id = 1;
List<? extends Yamcs.NamedObjectIdOrBuilder>	getIdOrBuilderList() repeated .yamcs.NamedObjectId id = 1;
Yamcs.NamedObjectId	getList(int index) Deprecated.
int	getListCount() Deprecated.
List<Yamcs.NamedObjectId>	getListList() Deprecated.
Yamcs.NamedObjectIdOrBuilder	getListOrBuilder(int index) Deprecated.
List<? extends Yamcs.NamedObjectIdOrBuilder>	getListOrBuilderList() Deprecated.
com.google.protobuf.Parser<Web.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
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
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	getUpdateOnExpiration() if set to true, send parameter updates when parameters expire.
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
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
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Web.ParameterSubscriptionRequest.Builder	newBuilder()
static Web.ParameterSubscriptionRequest.Builder	newBuilder(Web.ParameterSubscriptionRequest prototype)
Web.ParameterSubscriptionRequest.Builder	newBuilderForType()
protected Web.ParameterSubscriptionRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static Web.ParameterSubscriptionRequest	parseDelimitedFrom(InputStream input)
static Web.ParameterSubscriptionRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Web.ParameterSubscriptionRequest	parseFrom(byte[] data)
static Web.ParameterSubscriptionRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Web.ParameterSubscriptionRequest	parseFrom(com.google.protobuf.ByteString data)
static Web.ParameterSubscriptionRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Web.ParameterSubscriptionRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Web.ParameterSubscriptionRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Web.ParameterSubscriptionRequest	parseFrom(InputStream input)
static Web.ParameterSubscriptionRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Web.ParameterSubscriptionRequest>	parser()
Web.ParameterSubscriptionRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

LIST_FIELD_NUMBER

public static final int LIST_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Web.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.NamedObjectId id = 1;

Specified by:

getIdList in interface Web.ParameterSubscriptionRequestOrBuilder

getIdOrBuilderList

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

repeated .yamcs.NamedObjectId id = 1;

Specified by:

getIdOrBuilderList in interface Web.ParameterSubscriptionRequestOrBuilder

getIdCount

public int getIdCount()

repeated .yamcs.NamedObjectId id = 1;

Specified by:

getIdCount in interface Web.ParameterSubscriptionRequestOrBuilder

getId

public Yamcs.NamedObjectId getId(int index)

repeated .yamcs.NamedObjectId id = 1;

Specified by:

getId in interface Web.ParameterSubscriptionRequestOrBuilder

getIdOrBuilder

public Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)

repeated .yamcs.NamedObjectId id = 1;

Specified by:

getIdOrBuilder in interface Web.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 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

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

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

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

getListList

@Deprecated
public List<Yamcs.NamedObjectId> getListList()

Deprecated.

Hack to allow the old subscribe with NamedObjectList to work when json is used.
 When protobuf is used, the "id" will work since it uses the same field id (1) with the "list" from NamedObjectList
 remove this field when we are sure nobody uses the old method
 

repeated .yamcs.NamedObjectId list = 10000 [deprecated = true];

Specified by:

getListList in interface Web.ParameterSubscriptionRequestOrBuilder

getListOrBuilderList

@Deprecated
public List<? extends Yamcs.NamedObjectIdOrBuilder> getListOrBuilderList()

Deprecated.

Hack to allow the old subscribe with NamedObjectList to work when json is used.
 When protobuf is used, the "id" will work since it uses the same field id (1) with the "list" from NamedObjectList
 remove this field when we are sure nobody uses the old method
 

repeated .yamcs.NamedObjectId list = 10000 [deprecated = true];

Specified by:

getListOrBuilderList in interface Web.ParameterSubscriptionRequestOrBuilder

getListCount

@Deprecated
public int getListCount()

Deprecated.

Hack to allow the old subscribe with NamedObjectList to work when json is used.
 When protobuf is used, the "id" will work since it uses the same field id (1) with the "list" from NamedObjectList
 remove this field when we are sure nobody uses the old method
 

repeated .yamcs.NamedObjectId list = 10000 [deprecated = true];

Specified by:

getListCount in interface Web.ParameterSubscriptionRequestOrBuilder

getList

@Deprecated
public Yamcs.NamedObjectId getList(int index)

Deprecated.

Hack to allow the old subscribe with NamedObjectList to work when json is used.
 When protobuf is used, the "id" will work since it uses the same field id (1) with the "list" from NamedObjectList
 remove this field when we are sure nobody uses the old method
 

repeated .yamcs.NamedObjectId list = 10000 [deprecated = true];

Specified by:

getList in interface Web.ParameterSubscriptionRequestOrBuilder

getListOrBuilder

@Deprecated
public Yamcs.NamedObjectIdOrBuilder getListOrBuilder(int index)

Deprecated.

Hack to allow the old subscribe with NamedObjectList to work when json is used.
 When protobuf is used, the "id" will work since it uses the same field id (1) with the "list" from NamedObjectList
 remove this field when we are sure nobody uses the old method
 

repeated .yamcs.NamedObjectId list = 10000 [deprecated = true];

Specified by:

getListOrBuilder in interface Web.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 Web.ParameterSubscriptionRequest parseFrom(com.google.protobuf.ByteString data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Web.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 Web.ParameterSubscriptionRequest parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Web.ParameterSubscriptionRequest parseFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Web.ParameterSubscriptionRequest parseDelimitedFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Web.ParameterSubscriptionRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Web.ParameterSubscriptionRequest.Builder newBuilder()

newBuilder

public static Web.ParameterSubscriptionRequest.Builder newBuilder(Web.ParameterSubscriptionRequest prototype)

toBuilder

public Web.ParameterSubscriptionRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Web.ParameterSubscriptionRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Web.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 Web.ParameterSubscriptionRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder