Module org.yamcs.api
Package org.yamcs.protobuf

Class SubscribeParametersRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<SubscribeParametersRequest.Builder>
org.yamcs.protobuf.SubscribeParametersRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, SubscribeParametersRequestOrBuilder
Enclosing class:
SubscribeParametersRequest
public static final class SubscribeParametersRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SubscribeParametersRequest.Builder> implements SubscribeParametersRequestOrBuilder
 Request message for `SubscribeParameters`.
Protobuf type yamcs.protobuf.processing.SubscribeParametersRequest

  • Method Details

    • 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<SubscribeParametersRequest.Builder>

    • clear

      public SubscribeParametersRequest.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<SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • getDefaultInstanceForType

      public SubscribeParametersRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SubscribeParametersRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SubscribeParametersRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • setField

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • clearField

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • clearOneof

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • setRepeatedField

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • addRepeatedField

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • mergeFrom

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • mergeFrom

      public SubscribeParametersRequest.Builder mergeFrom(SubscribeParametersRequest other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SubscribeParametersRequest.Builder>

    • mergeFrom

      public SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>
      Throws:
      IOException

    • hasInstance

      public boolean hasInstance()
       Yamcs instance name.
      optional string instance = 1;
      Specified by:
      hasInstance in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name.
      optional string instance = 1;
      Specified by:
      getInstance in interface SubscribeParametersRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

      public com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name.
      optional string instance = 1;
      Specified by:
      getInstanceBytes in interface SubscribeParametersRequestOrBuilder
      Returns:
      The bytes for instance.

    • setInstance

      public SubscribeParametersRequest.Builder setInstance(String value)
       Yamcs instance name.
      optional string instance = 1;
      Parameters:
      value - The instance to set.
      Returns:
      This builder for chaining.

    • clearInstance

      public SubscribeParametersRequest.Builder clearInstance()
       Yamcs instance name.
      optional string instance = 1;
      Returns:
      This builder for chaining.

    • setInstanceBytes

      public SubscribeParametersRequest.Builder setInstanceBytes(com.google.protobuf.ByteString value)
       Yamcs instance name.
      optional string instance = 1;
      Parameters:
      value - The bytes for instance to set.
      Returns:
      This builder for chaining.

    • hasProcessor

      public boolean hasProcessor()
       Processor name.
      optional string processor = 2;
      Specified by:
      hasProcessor in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the processor field is set.

    • getProcessor

      public String getProcessor()
       Processor name.
      optional string processor = 2;
      Specified by:
      getProcessor in interface SubscribeParametersRequestOrBuilder
      Returns:
      The processor.

    • getProcessorBytes

      public com.google.protobuf.ByteString getProcessorBytes()
       Processor name.
      optional string processor = 2;
      Specified by:
      getProcessorBytes in interface SubscribeParametersRequestOrBuilder
      Returns:
      The bytes for processor.

    • setProcessor

      public SubscribeParametersRequest.Builder setProcessor(String value)
       Processor name.
      optional string processor = 2;
      Parameters:
      value - The processor to set.
      Returns:
      This builder for chaining.

    • clearProcessor

      public SubscribeParametersRequest.Builder clearProcessor()
       Processor name.
      optional string processor = 2;
      Returns:
      This builder for chaining.

    • setProcessorBytes

      public SubscribeParametersRequest.Builder setProcessorBytes(com.google.protobuf.ByteString value)
       Processor name.
      optional string processor = 2;
      Parameters:
      value - The bytes for processor to set.
      Returns:
      This builder for chaining.

    • getIdList

      public List<Yamcs.NamedObjectId> getIdList()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdList in interface SubscribeParametersRequestOrBuilder

    • getIdCount

      public int getIdCount()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdCount in interface SubscribeParametersRequestOrBuilder

    • getId

      public Yamcs.NamedObjectId getId(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getId in interface SubscribeParametersRequestOrBuilder

    • setId

      public SubscribeParametersRequest.Builder setId(int index, Yamcs.NamedObjectId value)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • setId

      public SubscribeParametersRequest.Builder setId(int index, Yamcs.NamedObjectId.Builder builderForValue)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • addId

      public SubscribeParametersRequest.Builder addId(Yamcs.NamedObjectId value)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • addId

      public SubscribeParametersRequest.Builder addId(int index, Yamcs.NamedObjectId value)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • addId

      public SubscribeParametersRequest.Builder addId(Yamcs.NamedObjectId.Builder builderForValue)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • addId

      public SubscribeParametersRequest.Builder addId(int index, Yamcs.NamedObjectId.Builder builderForValue)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • addAllId

      public SubscribeParametersRequest.Builder addAllId(Iterable<? extends Yamcs.NamedObjectId> values)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • clearId

      public SubscribeParametersRequest.Builder clearId()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • removeId

      public SubscribeParametersRequest.Builder removeId(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • getIdBuilder

      public Yamcs.NamedObjectId.Builder getIdBuilder(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • getIdOrBuilder

      public Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdOrBuilder in interface SubscribeParametersRequestOrBuilder

    • getIdOrBuilderList

      public List<? extends Yamcs.NamedObjectIdOrBuilder> getIdOrBuilderList()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdOrBuilderList in interface SubscribeParametersRequestOrBuilder

    • addIdBuilder

      public Yamcs.NamedObjectId.Builder addIdBuilder()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • addIdBuilder

      public Yamcs.NamedObjectId.Builder addIdBuilder(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • getIdBuilderList

      public List<Yamcs.NamedObjectId.Builder> getIdBuilderList()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;

    • hasAbortOnInvalid

      public boolean hasAbortOnInvalid()
       Send an error message if any parameter is invalid.
 Default: true
      optional bool abortOnInvalid = 4;
      Specified by:
      hasAbortOnInvalid in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the abortOnInvalid field is set.

    • getAbortOnInvalid

      public boolean getAbortOnInvalid()
       Send an error message if any parameter is invalid.
 Default: true
      optional bool abortOnInvalid = 4;
      Specified by:
      getAbortOnInvalid in interface SubscribeParametersRequestOrBuilder
      Returns:
      The abortOnInvalid.

    • setAbortOnInvalid

      public SubscribeParametersRequest.Builder setAbortOnInvalid(boolean value)
       Send an error message if any parameter is invalid.
 Default: true
      optional bool abortOnInvalid = 4;
      Parameters:
      value - The abortOnInvalid to set.
      Returns:
      This builder for chaining.

    • clearAbortOnInvalid

      public SubscribeParametersRequest.Builder clearAbortOnInvalid()
       Send an error message if any parameter is invalid.
 Default: true
      optional bool abortOnInvalid = 4;
      Returns:
      This builder for chaining.

    • hasUpdateOnExpiration

      public boolean hasUpdateOnExpiration()
       Send parameter updates when parameters expire.
 The update will have the same value and timestamp like
 the preceding update, but with acquisition status set to
 EXPIRED (instead of ACQUIRED)
 Default: false
      optional bool updateOnExpiration = 5;
      Specified by:
      hasUpdateOnExpiration in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the updateOnExpiration field is set.

    • getUpdateOnExpiration

      public boolean getUpdateOnExpiration()
       Send parameter updates when parameters expire.
 The update will have the same value and timestamp like
 the preceding update, but with acquisition status set to
 EXPIRED (instead of ACQUIRED)
 Default: false
      optional bool updateOnExpiration = 5;
      Specified by:
      getUpdateOnExpiration in interface SubscribeParametersRequestOrBuilder
      Returns:
      The updateOnExpiration.

    • setUpdateOnExpiration

      public SubscribeParametersRequest.Builder setUpdateOnExpiration(boolean value)
       Send parameter updates when parameters expire.
 The update will have the same value and timestamp like
 the preceding update, but with acquisition status set to
 EXPIRED (instead of ACQUIRED)
 Default: false
      optional bool updateOnExpiration = 5;
      Parameters:
      value - The updateOnExpiration to set.
      Returns:
      This builder for chaining.

    • clearUpdateOnExpiration

      public SubscribeParametersRequest.Builder clearUpdateOnExpiration()
       Send parameter updates when parameters expire.
 The update will have the same value and timestamp like
 the preceding update, but with acquisition status set to
 EXPIRED (instead of ACQUIRED)
 Default: false
      optional bool updateOnExpiration = 5;
      Returns:
      This builder for chaining.

    • hasSendFromCache

      public boolean hasSendFromCache()
       If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true
      optional bool sendFromCache = 6;
      Specified by:
      hasSendFromCache in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the sendFromCache field is set.

    • getSendFromCache

      public boolean getSendFromCache()
       If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true
      optional bool sendFromCache = 6;
      Specified by:
      getSendFromCache in interface SubscribeParametersRequestOrBuilder
      Returns:
      The sendFromCache.

    • setSendFromCache

      public SubscribeParametersRequest.Builder setSendFromCache(boolean value)
       If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true
      optional bool sendFromCache = 6;
      Parameters:
      value - The sendFromCache to set.
      Returns:
      This builder for chaining.

    • clearSendFromCache

      public SubscribeParametersRequest.Builder clearSendFromCache()
       If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true
      optional bool sendFromCache = 6;
      Returns:
      This builder for chaining.

    • hasAction

      public boolean hasAction()
       How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.
      optional .yamcs.protobuf.processing.SubscribeParametersRequest.Action action = 7;
      Specified by:
      hasAction in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the action field is set.

    • getAction

      public SubscribeParametersRequest.Action getAction()
       How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.
      optional .yamcs.protobuf.processing.SubscribeParametersRequest.Action action = 7;
      Specified by:
      getAction in interface SubscribeParametersRequestOrBuilder
      Returns:
      The action.

    • setAction

      public SubscribeParametersRequest.Builder setAction(SubscribeParametersRequest.Action value)
       How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.
      optional .yamcs.protobuf.processing.SubscribeParametersRequest.Action action = 7;
      Parameters:
      value - The action to set.
      Returns:
      This builder for chaining.

    • clearAction

      public SubscribeParametersRequest.Builder clearAction()
       How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.
      optional .yamcs.protobuf.processing.SubscribeParametersRequest.Action action = 7;
      Returns:
      This builder for chaining.

    • hasMaxBytes

      public boolean hasMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
 A negative value implies no truncating, which is the default.
      optional int32 maxBytes = 8;
      Specified by:
      hasMaxBytes in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the maxBytes field is set.

    • getMaxBytes

      public int getMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
 A negative value implies no truncating, which is the default.
      optional int32 maxBytes = 8;
      Specified by:
      getMaxBytes in interface SubscribeParametersRequestOrBuilder
      Returns:
      The maxBytes.

    • setMaxBytes

      public SubscribeParametersRequest.Builder setMaxBytes(int value)
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
 A negative value implies no truncating, which is the default.
      optional int32 maxBytes = 8;
      Parameters:
      value - The maxBytes to set.
      Returns:
      This builder for chaining.

    • clearMaxBytes

      public SubscribeParametersRequest.Builder clearMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
 A negative value implies no truncating, which is the default.
      optional int32 maxBytes = 8;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>

    • mergeUnknownFields

      public final SubscribeParametersRequest.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<SubscribeParametersRequest.Builder>