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

Class ClientMessage.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<ClientMessage.Builder>
com.google.protobuf.GeneratedMessage.Builder<ClientMessage.Builder>
org.yamcs.protobuf.ClientMessage.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, ClientMessageOrBuilder
Enclosing class:
ClientMessage
public static final class ClientMessage.Builder extends com.google.protobuf.GeneratedMessage.Builder<ClientMessage.Builder> implements ClientMessageOrBuilder
Protobuf type yamcs.api.ClientMessage

  • Method Summary

    Modifier and Type
    Method
    Description
    ClientMessage
    build()
     
    ClientMessage
    buildPartial()
     
    ClientMessage.Builder
    clear()
     
    ClientMessage.Builder
    clearCall()
    If applicable, the call associated with this message This should be used when the client is streaming multiple messages handled by the same call.
    ClientMessage.Builder
    clearId()
    Optional client-side message identifier, returned in reply messages.
    ClientMessage.Builder
    clearLowPriority()
    If set to true, permit the server to drop messages if writing the message would cause the channel to exceed the highWaterMark (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/) This attribute is only applied when it is set on the first message of a call.
    ClientMessage.Builder
    clearMaxDroppedWrites()
    Deprecated.
    yamcs.api.ClientMessage.maxDroppedWrites is deprecated.
    ClientMessage.Builder
    clearOptions()
    Options specific to the type
    ClientMessage.Builder
    clearType()
    Message type.
    int
    getCall()
    If applicable, the call associated with this message This should be used when the client is streaming multiple messages handled by the same call.
    ClientMessage
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    int
    getId()
    Optional client-side message identifier, returned in reply messages.
    boolean
    getLowPriority()
    If set to true, permit the server to drop messages if writing the message would cause the channel to exceed the highWaterMark (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/) This attribute is only applied when it is set on the first message of a call.
    int
    getMaxDroppedWrites()
    Deprecated.
    yamcs.api.ClientMessage.maxDroppedWrites is deprecated.
    com.google.protobuf.Any
    getOptions()
    Options specific to the type
    com.google.protobuf.Any.Builder
    getOptionsBuilder()
    Options specific to the type
    com.google.protobuf.AnyOrBuilder
    getOptionsOrBuilder()
    Options specific to the type
    String
    getType()
    Message type.
    com.google.protobuf.ByteString
    getTypeBytes()
    Message type.
    boolean
    hasOptions()
    Options specific to the type
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    ClientMessage.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    ClientMessage.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    ClientMessage.Builder
    mergeFrom(ClientMessage other)
     
    ClientMessage.Builder
    mergeOptions(com.google.protobuf.Any value)
    Options specific to the type
    ClientMessage.Builder
    setCall(int value)
    If applicable, the call associated with this message This should be used when the client is streaming multiple messages handled by the same call.
    ClientMessage.Builder
    setId(int value)
    Optional client-side message identifier, returned in reply messages.
    ClientMessage.Builder
    setLowPriority(boolean value)
    If set to true, permit the server to drop messages if writing the message would cause the channel to exceed the highWaterMark (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/) This attribute is only applied when it is set on the first message of a call.
    ClientMessage.Builder
    setMaxDroppedWrites(int value)
    Deprecated.
    yamcs.api.ClientMessage.maxDroppedWrites is deprecated.
    ClientMessage.Builder
    setOptions(com.google.protobuf.Any value)
    Options specific to the type
    ClientMessage.Builder
    setOptions(com.google.protobuf.Any.Builder builderForValue)
    Options specific to the type
    ClientMessage.Builder
    setType(String value)
    Message type.
    ClientMessage.Builder
    setTypeBytes(com.google.protobuf.ByteString value)
    Message type.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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

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

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

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

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ClientMessage.Builder>

    • clear

      public ClientMessage.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.GeneratedMessage.Builder<ClientMessage.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.GeneratedMessage.Builder<ClientMessage.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public ClientMessage.Builder mergeFrom(ClientMessage other)

    • isInitialized

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

    • mergeFrom

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

    • getType

      public String getType()
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Specified by:
      getType in interface ClientMessageOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Specified by:
      getTypeBytes in interface ClientMessageOrBuilder
      Returns:
      The bytes for type.

    • setType

      public ClientMessage.Builder setType(String value)
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public ClientMessage.Builder clearType()
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Returns:
      This builder for chaining.

    • setTypeBytes

      public ClientMessage.Builder setTypeBytes(com.google.protobuf.ByteString value)
       Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
      string type = 1;
      Parameters:
      value - The bytes for type to set.
      Returns:
      This builder for chaining.

    • hasOptions

      public boolean hasOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Specified by:
      hasOptions in interface ClientMessageOrBuilder
      Returns:
      Whether the options field is set.

    • getOptions

      public com.google.protobuf.Any getOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Specified by:
      getOptions in interface ClientMessageOrBuilder
      Returns:
      The options.

    • setOptions

      public ClientMessage.Builder setOptions(com.google.protobuf.Any value)
       Options specific to the type
      .google.protobuf.Any options = 2;

    • setOptions

      public ClientMessage.Builder setOptions(com.google.protobuf.Any.Builder builderForValue)
       Options specific to the type
      .google.protobuf.Any options = 2;

    • mergeOptions

      public ClientMessage.Builder mergeOptions(com.google.protobuf.Any value)
       Options specific to the type
      .google.protobuf.Any options = 2;

    • clearOptions

      public ClientMessage.Builder clearOptions()
       Options specific to the type
      .google.protobuf.Any options = 2;

    • getOptionsBuilder

      public com.google.protobuf.Any.Builder getOptionsBuilder()
       Options specific to the type
      .google.protobuf.Any options = 2;

    • getOptionsOrBuilder

      public com.google.protobuf.AnyOrBuilder getOptionsOrBuilder()
       Options specific to the type
      .google.protobuf.Any options = 2;
      Specified by:
      getOptionsOrBuilder in interface ClientMessageOrBuilder

    • getId

      public int getId()
       Optional client-side message identifier, returned in reply messages.
      int32 id = 3;
      Specified by:
      getId in interface ClientMessageOrBuilder
      Returns:
      The id.

    • setId

      public ClientMessage.Builder setId(int value)
       Optional client-side message identifier, returned in reply messages.
      int32 id = 3;
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.

    • clearId

      public ClientMessage.Builder clearId()
       Optional client-side message identifier, returned in reply messages.
      int32 id = 3;
      Returns:
      This builder for chaining.

    • getCall

      public int getCall()
       If applicable, the call associated with this message
 This should be used when the client is streaming multiple messages
 handled by the same call.
      int32 call = 4;
      Specified by:
      getCall in interface ClientMessageOrBuilder
      Returns:
      The call.

    • setCall

      public ClientMessage.Builder setCall(int value)
       If applicable, the call associated with this message
 This should be used when the client is streaming multiple messages
 handled by the same call.
      int32 call = 4;
      Parameters:
      value - The call to set.
      Returns:
      This builder for chaining.

    • clearCall

      public ClientMessage.Builder clearCall()
       If applicable, the call associated with this message
 This should be used when the client is streaming multiple messages
 handled by the same call.
      int32 call = 4;
      Returns:
      This builder for chaining.

    • getMaxDroppedWrites

      @Deprecated public int getMaxDroppedWrites()
      Deprecated.
      yamcs.api.ClientMessage.maxDroppedWrites is deprecated. See yamcs/api/websocket.proto;l=34
       If set, permit the server to keep a WebSocket connection despite frame writes
 getting dropped (channel not open or not writable). If unset the default is 0,
 meaning that if the server can't write a frame, it will close the connection
 (impacting all calls on that connection).

 This attribute is only applied when it is set on the first message of a call.
 Since Yamcs 5.7.6 this option is deprecated in favour of lowPriority below.
      int32 maxDroppedWrites = 5 [deprecated = true];
      Specified by:
      getMaxDroppedWrites in interface ClientMessageOrBuilder
      Returns:
      The maxDroppedWrites.

    • setMaxDroppedWrites

      @Deprecated public ClientMessage.Builder setMaxDroppedWrites(int value)
      Deprecated.
      yamcs.api.ClientMessage.maxDroppedWrites is deprecated. See yamcs/api/websocket.proto;l=34
       If set, permit the server to keep a WebSocket connection despite frame writes
 getting dropped (channel not open or not writable). If unset the default is 0,
 meaning that if the server can't write a frame, it will close the connection
 (impacting all calls on that connection).

 This attribute is only applied when it is set on the first message of a call.
 Since Yamcs 5.7.6 this option is deprecated in favour of lowPriority below.
      int32 maxDroppedWrites = 5 [deprecated = true];
      Parameters:
      value - The maxDroppedWrites to set.
      Returns:
      This builder for chaining.

    • clearMaxDroppedWrites

      @Deprecated public ClientMessage.Builder clearMaxDroppedWrites()
      Deprecated.
      yamcs.api.ClientMessage.maxDroppedWrites is deprecated. See yamcs/api/websocket.proto;l=34
       If set, permit the server to keep a WebSocket connection despite frame writes
 getting dropped (channel not open or not writable). If unset the default is 0,
 meaning that if the server can't write a frame, it will close the connection
 (impacting all calls on that connection).

 This attribute is only applied when it is set on the first message of a call.
 Since Yamcs 5.7.6 this option is deprecated in favour of lowPriority below.
      int32 maxDroppedWrites = 5 [deprecated = true];
      Returns:
      This builder for chaining.

    • getLowPriority

      public boolean getLowPriority()
       If set to true, permit the server to drop messages if writing the message would cause the
 channel to exceed the highWaterMark
 (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/)
 This attribute is only applied when it is set on the first message of a call.

 Note that if a message exceeds the highWaterMark, with this option set it will always be dropped.
 A warning will be printed in the Yamcs logs in this case.
      bool lowPriority = 6;
      Specified by:
      getLowPriority in interface ClientMessageOrBuilder
      Returns:
      The lowPriority.

    • setLowPriority

      public ClientMessage.Builder setLowPriority(boolean value)
       If set to true, permit the server to drop messages if writing the message would cause the
 channel to exceed the highWaterMark
 (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/)
 This attribute is only applied when it is set on the first message of a call.

 Note that if a message exceeds the highWaterMark, with this option set it will always be dropped.
 A warning will be printed in the Yamcs logs in this case.
      bool lowPriority = 6;
      Parameters:
      value - The lowPriority to set.
      Returns:
      This builder for chaining.

    • clearLowPriority

      public ClientMessage.Builder clearLowPriority()
       If set to true, permit the server to drop messages if writing the message would cause the
 channel to exceed the highWaterMark
 (see https://docs.yamcs.org/yamcs-server-manual/services/global/http-server/)
 This attribute is only applied when it is set on the first message of a call.

 Note that if a message exceeds the highWaterMark, with this option set it will always be dropped.
 A warning will be printed in the Yamcs logs in this case.
      bool lowPriority = 6;
      Returns:
      This builder for chaining.