Package org.yamcs.protobuf
Class ClientMessage.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.Builder<ClientMessage.Builder>
implements ClientMessageOrBuilder
Protobuf type
yamcs.api.ClientMessage
-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
If applicable, the call associated with this message This should be used when the client is streaming multiple messages handled by the same call.clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) clearId()
Optional client-side message identifier, returned in reply messages.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.Deprecated.clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) Options specific to the typeMessage type.clone()
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.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
int
getId()
Optional client-side message identifier, returned in reply messages.boolean
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
Deprecated.com.google.protobuf.Any
Options specific to the typecom.google.protobuf.Any.Builder
Options specific to the typecom.google.protobuf.AnyOrBuilder
Options specific to the typegetType()
Message type.com.google.protobuf.ByteString
Message type.boolean
Options specific to the typeprotected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(ClientMessage other) mergeOptions
(com.google.protobuf.Any value) Options specific to the typefinal ClientMessage.Builder
mergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) 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.setId
(int value) Optional client-side message identifier, returned in reply messages.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.setMaxDroppedWrites
(int value) Deprecated.setOptions
(com.google.protobuf.Any value) Options specific to the typesetOptions
(com.google.protobuf.Any.Builder builderForValue) Options specific to the typesetRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) Message type.setTypeBytes
(com.google.protobuf.ByteString value) Message type.final ClientMessage.Builder
setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, 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.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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
setField
public ClientMessage.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
clearField
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
clearOneof
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
setRepeatedField
public ClientMessage.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
addRepeatedField
public ClientMessage.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ClientMessage.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
mergeFrom
public ClientMessage.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<ClientMessage.Builder>
- Throws:
IOException
-
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 interfaceClientMessageOrBuilder
- 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 interfaceClientMessageOrBuilder
- Returns:
- The bytes for type.
-
setType
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
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
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 interfaceClientMessageOrBuilder
- 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 interfaceClientMessageOrBuilder
- Returns:
- The options.
-
setOptions
Options specific to the type
.google.protobuf.Any options = 2;
-
setOptions
Options specific to the type
.google.protobuf.Any options = 2;
-
mergeOptions
Options specific to the type
.google.protobuf.Any options = 2;
-
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 interfaceClientMessageOrBuilder
-
getId
public int getId()Optional client-side message identifier, returned in reply messages.
int32 id = 3;
- Specified by:
getId
in interfaceClientMessageOrBuilder
- Returns:
- The id.
-
setId
Optional client-side message identifier, returned in reply messages.
int32 id = 3;
- Parameters:
value
- The id to set.- Returns:
- This builder for chaining.
-
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 interfaceClientMessageOrBuilder
- Returns:
- The call.
-
setCall
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
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.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 interfaceClientMessageOrBuilder
- Returns:
- The maxDroppedWrites.
-
setMaxDroppedWrites
Deprecated.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.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 interfaceClientMessageOrBuilder
- Returns:
- The lowPriority.
-
setLowPriority
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
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.
-
setUnknownFields
public final ClientMessage.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-
mergeUnknownFields
public final ClientMessage.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<ClientMessage.Builder>
-