• Home
• org.yamcs
• yamcs-api
• 5.11.1
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

cs-api.5.11.1.source-code.yamcs-api.protobin Maven / Gradle / Ivy

?.
google/protobuf/any.protogoogle.protobuf"6
Any
type_url
 
(	RtypeUrl
value 
(RvalueBv
com.google.protobufBAnyProtoP
Z,google.golang.org/protobuf/types/known/anypb?GPB?Google.Protobuf.WellKnownTypesJ?,
?


?

2? Protocol Buffers - Google's data interchange format
 Copyright 2008 Google Inc.  All rights reserved.
 https://developers.google.com/protocol-buffers/

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:

     * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above
 copyright notice, this list of conditions and the following disclaimer
 in the documentation and/or other materials provided with the
 distribution.
     * Neither the name of Google Inc. nor the names of its
 contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.



 


"C
	
"C


#,
	

#,


$)
	
$)


%"
	

%"


&!
	
$&!


';
	
%';
?
?

? `Any` contains an arbitrary serialized protocol buffer message along with a
 URL that describes the type of the serialized message.

 Protobuf library provides support to pack/unpack Any values in the form
 of utility functions or additional generated methods of the Any type.

 Example 1: Pack and unpack a message in C++.

     Foo foo = ...;
     Any any;
     any.PackFrom(foo);
     ...
     if (any.UnpackTo(&foo)) {
       ...
     }

 Example 2: Pack and unpack a message in Java.

     Foo foo = ...;
     Any any = Any.pack(foo);
     ...
     if (any.is(Foo.class)) {
       foo = any.unpack(Foo.class);
     }
     // or ...
     if (any.isSameTypeAs(Foo.getDefaultInstance())) {
       foo = any.unpack(Foo.getDefaultInstance());
     }

  Example 3: Pack and unpack a message in Python.

     foo = Foo(...)
     any = Any()
     any.Pack(foo)
     ...
     if any.Is(Foo.DESCRIPTOR):
       any.Unpack(foo)
       ...

  Example 4: Pack and unpack a message in Go

      foo := &pb.Foo{...}
      any, err := anypb.New(foo)
      if err != nil {
        ...
      }
      ...
      foo := &pb.Foo{}
      if err := any.UnmarshalTo(foo); err != nil {
        ...
      }

 The pack methods provided by protobuf library will by default use
 'type.googleapis.com/full.type.name' as the type URL and the unpack
 methods only use the fully qualified type name after the last '/'
 in the type URL, for example "foo.bar.com/x/y.z" will yield type
 name "y.z".

 JSON
 ====
 The JSON representation of an `Any` value uses the regular
 representation of the deserialized, embedded message, with an
 additional field `@type` which contains the type URL. Example:

     package google.profile;
     message Person {
       string first_name = 1;
       string last_name = 2;
     }

     {
       "@type": "type.googleapis.com/google.profile.Person",
       "firstName": ,
       "lastName": 
     }

 If the embedded message type is well-known and has a custom JSON
 representation, that representation will be embedded adding a field
 `value` which holds the custom JSON in addition to the `@type`
 field. Example (for message [google.protobuf.Duration][]):

     {
       "@type": "type.googleapis.com/google.protobuf.Duration",
       "value": "1.212s"
     }






?
?
? A URL/resource name that uniquely identifies the type of the serialized
 protocol buffer message. This string must contain at least
 one "/" character. The last segment of the URL's path must represent
 the fully qualified name of the type (as in
 `path/google.protobuf.Duration`). The name should be in a canonical form
 (e.g., leading "." is not accepted).

 In practice, teams usually precompile into the binary all types that they
 expect it to use in the context of Any. However, for URLs which use the
 scheme `http`, `https`, or no scheme, one can optionally set up a type
 server that maps type URLs to message definitions as follows:

 * If no scheme is provided, `https` is assumed.
 * An HTTP GET on the URL must yield a [google.protobuf.Type][]
   value in binary format, or produce an error.
 * Applications are allowed to cache lookup results based on the
   URL, or have them precompiled into a binary to avoid any
   lookup. Therefore, binary compatibility needs to be preserved
   on changes to types. (Use versioned type names to manage
   breaking changes.)

 Note: this functionality is not currently available in the official
 protobuf release, and it is not used for type URLs beginning with
 type.googleapis.com. As of May 2023, there are no widely used type server
 implementations and no plans to implement one.

 Schemes other than `http`, `https` (or the empty scheme) might be
 used with implementation specific semantics.



?



?
	

?

W

?
I Must be a valid serialized protocol buffer of the above specified type.



?




?



?
bproto3
?	
yamcs/api/exception.proto	yamcs.apigoogle/protobuf/any.proto"z
ExceptionMessage
code
 
(Rcode
type 
(	Rtype
msg 
(	Rmsg,
detail 
(2.google.protobuf.AnyRdetail"?

FilterSyntaxException
	beginLine
 
(R	beginLine 
beginColumn 
(RbeginColumn
endLine 
(RendLine
	endColumn 
(R	endColumnB!

org.yamcs.apiBExceptionProtoP
J?








	
#


"
	

"


/
	
/


&
	

&
-

! Generic holder for an exception


























	










	



!






 










A

4 Begin line of the token where the exception occurs











C


6 Begin column of the token where the exception occurs














?

2 End line of the token where the exception occurs











A

4 End column of the token where the exception occurs










bproto3
?
yamcs/api/websocket.proto	yamcs.apigoogle/protobuf/any.protoyamcs/api/exception.proto"?


ClientMessage
type
 
(	Rtype.
options 
(2.google.protobuf.AnyRoptions
id 
(Rid
call 
(Rcall.
maxDroppedWrites 
(B
RmaxDroppedWrites 
lowPriority 
(RlowPriority"s

ServerMessage
type
 
(	Rtype
call 
(Rcall
seq 
(Rseq(
data 
(2.google.protobuf.AnyRdata"#

CancelOptions
call
 
(Rcall"]
Reply
reply_to
 
(RreplyTo9
	exception 
(2.yamcs.api.ExceptionMessageR	exception"?

State/
calls
 (2.yamcs.api.State.CallInfoRcallsb
CallInfo
call
 
(Rcall
type 
(	Rtype.
options 
(2.google.protobuf.AnyRoptionsB&
org.yamcs.protobufBWebSocketProtoP
J?
U









+
	

+


/
	
/


"
	

"
	
#
	


#


-





h
[ Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".





	


+

" Options specific to the type










 !
S
F Optional client-side message identifier, returned in reply messages.










?

?
 If applicable, the call associated with this message
 This should be used when the client is streaming multiple messages
 handled by the same call.








?
"1? 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.


"


"

"

"0

"/
?
,?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.



,


,

,



/;





/
d

2W Message type. Typically the name of the subscribed topic, or a built-in like "reply".



2



2	


2
C


56 If applicable, the call associated with this message




5




5



5
4

8' Sequence counter (scoped to the call)



8



8


8


:


:



:


:
?

?A
 Message to be provided in a ClientMessage if type is "cancel".
 This is a special message type that allows cancelling a call.




?

@

@


@

@
]
DK
Q Message to be provided in the data field of a ServerMessage if type is "reply".




D
B
G5 The id of the original client message (if provided)


G


G

G
3

J!& If set, the call was not successful.



J



J


J 
]
NU
Q Message to be provided in the data field of a ServerMessage if type is "state".




N

OS


O


P

P	


P


P


Q


Q




Q


Q

R$

R


R

R"#

T

T


T


T

Tbproto3
?
yamcs/api/httpbody.proto	yamcs.api"?

HttpBody!
content_type
 
(	RcontentType
filename 
(	Rfilename
data 
(Rdata=
metadata (2!.yamcs.api.HttpBody.MetadataEntryRmetadata;

MetadataEntry
key
 
(	Rkey
value 
(	Rvalue:8
B 

org.yamcs.apiB
HttpBodyProtoP
J?










"
	

"


.
	
.


&
	

&








q
#d The Content-Type header value for this body.
 If unspecified, defaults to application/octet-stream










!"
z

m If set, a Content-Disposition header is added
 to the response. Weg agents use this to trigger
 a download.















%
 The body as raw binary











:
#- Any other metadata (used in multipart/form)







!"
??
 google/protobuf/descriptor.protogoogle.protobuf"M
FileDescriptorSet8
file
 (2$.google.protobuf.FileDescriptorProtoRfile"?
FileDescriptorProto
name
 
(	Rname
package 
(	Rpackage

dependency (	R
dependency+
public_dependency
 (RpublicDependency'
weak_dependency (RweakDependencyC
message_type (2 .google.protobuf.DescriptorProtoRmessageTypeA
	enum_type (2$.google.protobuf.EnumDescriptorProtoRenumTypeA
service (2'.google.protobuf.ServiceDescriptorProtoRserviceC
	extension (2%.google.protobuf.FieldDescriptorProtoR	extension6
options 
(2.google.protobuf.FileOptionsRoptionsI
source_code_info	 
(2.google.protobuf.SourceCodeInfoRsourceCodeInfo
syntax 
(	Rsyntax2
edition 
(2.google.protobuf.EditionRedition"?
DescriptorProto
name
 
(	Rname;
field (2%.google.protobuf.FieldDescriptorProtoRfieldC
	extension (2%.google.protobuf.FieldDescriptorProtoR	extensionA
nested_type (2 .google.protobuf.DescriptorProtoR
nestedTypeA
	enum_type (2$.google.protobuf.EnumDescriptorProtoRenumTypeX
extension_range (2/.google.protobuf.DescriptorProto.ExtensionRangeRextensionRangeD

oneof_decl (2%.google.protobuf.OneofDescriptorProtoR	oneofDecl9
options 
(2.google.protobuf.MessageOptionsRoptionsU
reserved_range	 (2..google.protobuf.DescriptorProto.ReservedRangeR
reservedRange#

reserved_name
 (	RreservedNamez
ExtensionRange
start
 
(Rstart
end 
(Rend@
options 
(2&.google.protobuf.ExtensionRangeOptionsRoptions7

ReservedRange
start
 
(Rstart
end 
(Rend"?
ExtensionRangeOptionsX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOptionY
declaration (22.google.protobuf.ExtensionRangeOptions.DeclarationB?
Rdeclaration7
features2 
(2.google.protobuf.FeatureSetRfeaturesh
verification 
(28.google.protobuf.ExtensionRangeOptions.VerificationState:
UNVERIFIEDRverification?

Declaration
number
 
(Rnumber
	full_name 
(	RfullName
type 
(	Rtype
reserved 
(Rreserved
repeated 
(RrepeatedJ"4
VerificationState
DECLARATION

UNVERIFIED
*	?????"?
FieldDescriptorProto
name
 
(	Rname
number 
(RnumberA
label 
(2+.google.protobuf.FieldDescriptorProto.LabelRlabel>
type 
(2*.google.protobuf.FieldDescriptorProto.TypeRtype
	type_name 
(	RtypeName
extendee 
(	Rextendee#

default_value 
(	RdefaultValue
oneof_index	 
(R
oneofIndex
	json_name
 
(	RjsonName7
options 
(2.google.protobuf.FieldOptionsRoptions'
proto3_optional 
(Rproto3Optional"?
Type
TYPE_DOUBLE


TYPE_FLOAT

TYPE_INT64
TYPE_UINT64

TYPE_INT32
TYPE_FIXED64
TYPE_FIXED32
	TYPE_BOOL
TYPE_STRING	

TYPE_GROUP

TYPE_MESSAGE

TYPE_BYTES
TYPE_UINT32

	TYPE_ENUM

TYPE_SFIXED32

TYPE_SFIXED64
TYPE_SINT32
TYPE_SINT64"C
Label
LABEL_OPTIONAL

LABEL_REPEATED
LABEL_REQUIRED"c
OneofDescriptorProto
name
 
(	Rname7
options 
(2.google.protobuf.OneofOptionsRoptions"?
EnumDescriptorProto
name
 
(	Rname?
value (2).google.protobuf.EnumValueDescriptorProtoRvalue6
options 
(2.google.protobuf.EnumOptionsRoptions]
reserved_range (26.google.protobuf.EnumDescriptorProto.EnumReservedRangeR
reservedRange#

reserved_name (	RreservedName;
EnumReservedRange
start
 
(Rstart
end 
(Rend"?

EnumValueDescriptorProto
name
 
(	Rname
number 
(Rnumber;
options 
(2!.google.protobuf.EnumValueOptionsRoptions"?

ServiceDescriptorProto
name
 
(	Rname>
method (2&.google.protobuf.MethodDescriptorProtoRmethod9
options 
(2.google.protobuf.ServiceOptionsRoptions"?
MethodDescriptorProto
name
 
(	Rname

input_type 
(	R	inputType
output_type 
(	R
outputType8
options 
(2.google.protobuf.MethodOptionsRoptions0
client_streaming 
(:falseRclientStreaming0
server_streaming 
(:falseRserverStreaming"?	
FileOptions!
java_package
 
(	RjavaPackage0
java_outer_classname 
(	RjavaOuterClassname5
java_multiple_files
 
(:falseRjavaMultipleFilesD
java_generate_equals_and_hash 
(B
RjavaGenerateEqualsAndHash:
java_string_check_utf8 
(:falseRjavaStringCheckUtf8S
optimize_for	 
(2).google.protobuf.FileOptions.OptimizeMode:SPEEDRoptimizeFor

go_package 
(	R	goPackage5
cc_generic_services 
(:falseRccGenericServices9
java_generic_services 
(:falseRjavaGenericServices5
py_generic_services 
(:falseRpyGenericServices7
php_generic_services* 
(:falseRphpGenericServices%

deprecated 
(:falseR
deprecated.
cc_enable_arenas 
(:trueRccEnableArenas*
objc_class_prefix$ 
(	RobjcClassPrefix)
csharp_namespace% 
(	RcsharpNamespace!
swift_prefix' 
(	RswiftPrefix(
php_class_prefix( 
(	RphpClassPrefix#

php_namespace) 
(	RphpNamespace4
php_metadata_namespace, 
(	RphpMetadataNamespace!
ruby_package- 
(	RrubyPackage7
features2 
(2.google.protobuf.FeatureSetRfeaturesX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption":
OptimizeMode	
SPEED

	CODE_SIZE
LITE_RUNTIME*	?????J&'"?
MessageOptions<
message_set_wire_format
 
(:falseRmessageSetWireFormatL
no_standard_descriptor_accessor 
(:falseRnoStandardDescriptorAccessor%

deprecated 
(:falseR
deprecated
	map_entry 
(RmapEntryV
&deprecated_legacy_json_field_conflicts 
(B
R"deprecatedLegacyJsonFieldConflicts7
features 
(2.google.protobuf.FeatureSetRfeaturesX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption*	?????JJJJ	J	
"?

FieldOptionsA
ctype
 
(2#.google.protobuf.FieldOptions.CType:STRINGRctype
packed 
(RpackedG
jstype 
(2$.google.protobuf.FieldOptions.JSType:	JS_NORMALRjstype
lazy 
(:falseRlazy.
unverified_lazy 
(:falseRunverifiedLazy%

deprecated 
(:falseR
deprecated
weak
 
(:falseRweak(
debug_redact 
(:falseRdebugRedactK
	retention 
(2-.google.protobuf.FieldOptions.OptionRetentionR	retentionH
targets (2..google.protobuf.FieldOptions.OptionTargetTypeRtargetsW
edition_defaults (2,.google.protobuf.FieldOptions.EditionDefaultReditionDefaults7
features 
(2.google.protobuf.FeatureSetRfeaturesX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOptionZ
EditionDefault2
edition 
(2.google.protobuf.EditionRedition
value 
(	Rvalue"/
CType

STRING
CORD

STRING_PIECE"5
JSType
	JS_NORMAL
	JS_STRING

	JS_NUMBER"U
OptionRetention
RETENTION_UNKNOWN
RETENTION_RUNTIME

RETENTION_SOURCE"?
OptionTargetType
TARGET_TYPE_UNKNOWN
TARGET_TYPE_FILE

TARGET_TYPE_EXTENSION_RANGE
TARGET_TYPE_MESSAGE
TARGET_TYPE_FIELD
TARGET_TYPE_ONEOF
TARGET_TYPE_ENUM
TARGET_TYPE_ENUM_ENTRY
TARGET_TYPE_SERVICE
TARGET_TYPE_METHOD	*	?????JJ"?

OneofOptions7
features
 
(2.google.protobuf.FeatureSetRfeaturesX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption*	?????"?
EnumOptions
allow_alias 
(R
allowAlias%

deprecated 
(:falseR
deprecatedV
&deprecated_legacy_json_field_conflicts 
(B
R"deprecatedLegacyJsonFieldConflicts7
features 
(2.google.protobuf.FeatureSetRfeaturesX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption*	?????J"?
EnumValueOptions%

deprecated
 
(:falseR
deprecated7
features 
(2.google.protobuf.FeatureSetRfeatures(
debug_redact 
(:falseRdebugRedactX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption*	?????"?

ServiceOptions7
features" 
(2.google.protobuf.FeatureSetRfeatures%

deprecated! 
(:falseR
deprecatedX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption*	?????"?

MethodOptions%

deprecated! 
(:falseR
deprecatedq
idempotency_level" 
(2/.google.protobuf.MethodOptions.IdempotencyLevel:IDEMPOTENCY_UNKNOWNRidempotencyLevel7
features# 
(2.google.protobuf.FeatureSetRfeaturesX
uninterpreted_option? (2$.google.protobuf.UninterpretedOptionRuninterpretedOption"P
IdempotencyLevel
IDEMPOTENCY_UNKNOWN
NO_SIDE_EFFECTS


IDEMPOTENT*	?????"?
UninterpretedOptionA
name (2-.google.protobuf.UninterpretedOption.NamePartRname)
identifier_value 
(	RidentifierValue,
positive_int_value 
(RpositiveIntValue,
negative_int_value 
(RnegativeIntValue!
double_value 
(
RdoubleValue!
string_value 
(RstringValue'
aggregate_value 
(	RaggregateValueJ
NamePart
	name_part
 (	RnamePart!
is_extension (RisExtension"?	

FeatureSet?

field_presence
 
(2).google.protobuf.FeatureSet.FieldPresenceB9?

?
?

?

EXPLICIT??

IMPLICIT??

EXPLICIT?R
fieldPresencef
	enum_type 
(2$.google.protobuf.FeatureSet.EnumTypeB#?

?
?

?
CLOSED??
	OPEN?RenumType?

repeated_field_encoding 
(21.google.protobuf.FeatureSet.RepeatedFieldEncodingB'?

?
?

?

EXPANDED??
PACKED?RrepeatedFieldEncodingx
utf8_validation 
(2*.google.protobuf.FeatureSet.Utf8ValidationB#?

?
?

?
	NONE??
VERIFY?Rutf8Validationx
message_encoding 
(2+.google.protobuf.FeatureSet.MessageEncodingB ?

?
?

?
LENGTH_PREFIXED?RmessageEncoding|
json_format 
(2&.google.protobuf.FeatureSet.JsonFormatB3?

?
?
?

?
LEGACY_BEST_EFFORT??

ALLOW?R
jsonFormat"\

FieldPresence
FIELD_PRESENCE_UNKNOWN
EXPLICIT

IMPLICIT
LEGACY_REQUIRED"7
EnumType
ENUM_TYPE_UNKNOWN
OPEN


CLOSED"V
RepeatedFieldEncoding#
REPEATED_FIELD_ENCODING_UNKNOWN

PACKED

EXPANDED"C
Utf8Validation
UTF8_VALIDATION_UNKNOWN
NONE


VERIFY"S
MessageEncoding
MESSAGE_ENCODING_UNKNOWN
LENGTH_PREFIXED

	DELIMITED"H

JsonFormat
JSON_FORMAT_UNKNOWN	
ALLOW

LEGACY_BEST_EFFORT*??*??*?N?NJ??"?
FeatureSetDefaultsX
defaults
 (2<.google.protobuf.FeatureSetDefaults.FeatureSetEditionDefaultRdefaultsA
minimum_edition 
(2.google.protobuf.EditionRminimumEditionA
maximum_edition 
(2.google.protobuf.EditionRmaximumEdition?

FeatureSetEditionDefault2
edition 
(2.google.protobuf.EditionRedition7
features 
(2.google.protobuf.FeatureSetRfeatures"?
SourceCodeInfoD
location
 (2(.google.protobuf.SourceCodeInfo.LocationRlocation?

Location
path
 (B
Rpath
span (B
Rspan)
leading_comments 
(	RleadingComments+
trailing_comments 
(	RtrailingComments:
leading_detached_comments (	RleadingDetachedComments"?
GeneratedCodeInfoM

annotation
 (2-.google.protobuf.GeneratedCodeInfo.AnnotationR
annotation?


Annotation
path
 (B
Rpath
source_file 
(	R
sourceFile
begin 
(Rbegin
end 
(RendR
semantic 
(26.google.protobuf.GeneratedCodeInfo.Annotation.SemanticRsemantic"(
Semantic
NONE
SET
	
ALIAS*?

Edition
EDITION_UNKNOWN
EDITION_PROTO2?
EDITION_PROTO3?
EDITION_2023?
EDITION_1_TEST_ONLY

EDITION_2_TEST_ONLY
EDITION_99997_TEST_ONLY??
EDITION_99998_TEST_ONLY??
EDITION_99999_TEST_ONLY??B~
com.google.protobufBDescriptorProtosH
Z-google.golang.org/protobuf/types/descriptorpb?

?GPB?Google.Protobuf.ReflectionJ??
&?	

?

&2? Protocol Buffers - Google's data interchange format
 Copyright 2008 Google Inc.  All rights reserved.
 https://developers.google.com/protocol-buffers/

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:

     * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above
 copyright notice, this list of conditions and the following disclaimer
 in the documentation and/or other materials provided with the
 distribution.
     * Neither the name of Google Inc. nor the names of its
 contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2? Author: [email protected] (Kenton Varda)
  Based on original Protocol Buffers design by
  Sanjay Ghemawat, Jeff Dean, and others.

 The messages in this file describe the definitions found in .proto files.
 A valid .proto file can be translated directly to a FileDescriptorProto
 without any other information (e.g. without reading its imports).



(


*D
	
*D


+,
	

+,


,1
	
,1


-7
	
%-7


.!
	
$.!


/
	
/


3

	3t descriptor.proto must be optimized for speed because reflection-based
 algorithms don't work during bootstrapping.

j
79
^ The protocol compiler can output a FileDescriptorSet containing the .proto
 files it parses.




7

8(

8


8


8#

8&'
-
<S
! The full set of known editions.




<
:
>- A placeholder for an unknown edition value.



>

>
?

D?
 Legacy syntax "editions".  These pre-date editions, but behave much like
 distinct editions.  These can't be used to specify the edition of proto
 files, but feature definitions must supply proto2/proto3 defaults for
 backwards compatibility.




D


D

E


E

E
?

J?
 Editions that have been released.  The specific values are arbitrary and
 should not be depended on, but they will always be time-ordered for easy
 comparison.



J

J
}
Np Placeholder editions for testing feature resolution.  These should not be
 used or relyed on outside of tests.



N

N

O


O

O

P"


P

P!

Q"


Q

Q!

R"


R

R!
/

Vx
# Describes a complete .proto file.





V
9

W", file name, relative to root of source tree



W



W



W


W
*


X" e.g. "foo", "foo.bar", etc.




X




X




X



X
4

[!' Names of files imported by this file.



[



[



[


[ 
Q

](D Indexes of the public imported files in the dependency list above.



]



]



]"


]%'
z

`&m Indexes of the weak imported files in the dependency list.
 For Google-internal migration only. Do not use.



`



`



` 


`#%
6

c,) All top-level definitions in this file.



c



c



c'


c*+


d-


d



d



d(


d+,


e.


e



e!



e")


e,-


f.


f



f



f )


f,-


	h#


	h



	h


	
h


	h!"
?



n/?
 This field contains optional information about the original source code.
 You may safely remove this entire field without harming runtime
 functionality of the descriptors -- the information is needed only by
 development tools.




n




n




n*



n-.
?


t?
 The syntax of the proto file.
 The supported values are "proto2", "proto3", and "editions".

 If `edition` is present, this value must be "editions".



t



t



t


t
-

w   The edition of the proto file.



w



w



w


w
(
{?

 Describes a message type.




{

|

|


|


|

|


~*


~



~



~ %


~()

.







 )

,-

?
+

?



?



?
&

?
)*

?
-

?



?



?
(

?
+,

?
?



?



?
" Inclusive.


?


?




?


?



?
" Exclusive.



?



?





?



?


?
/

?


?

"


?
#*

?
-.

?
.

?



?



?
)

?
,-

?
/

?



?



?
 *

?
-.

?
&

?



?



?
!

?
$%
?


?
?
?
 Range of reserved tag numbers. Reserved tag numbers may not be used by
 fields or extension ranges in the same message. Reserved ranges may
 not overlap.




?




?
" Inclusive.



?



?





?



?




?
" Exclusive.




?




?






?




?


?
,

?



?



?
'

?
*+
?

	?
%u Reserved field names, which may not be used by fields in the same message.
 A given name may only be reserved once.


	?



	?


	
?


	?
"$

?
?




?

O
?
:A The parser stores options it doesn't recognize here. See above.


?



?



?
3

?
69

?
?



?


K
?
; The extension number declared within the extension range.


?


?




?


?

z

?
"j The fully-qualified name of the extension field. There must be a leading
 dot in front of the full name.



?



?





?



?
 !
?

?
?
 The fully-qualified type name of the extension field. Unlike
 Metadata.type, Declaration.type must have a leading dot for messages
 and enums.


?


?




?


?

?

?
?
 If true, indicates that the number is reserved in the extension range,
 and any extension field with the number will fail to compile. Set this
 when a declared extension field is deleted.


?


?




?


?

?

?
z If true, indicates that the extension must be defined as repeated.
 Otherwise the extension must be defined as optional.


?


?




?


?

$
	?
" removed is_repeated


	?



	
?



	?


?


?
F?
 For external users: DO NOT USE. We are in the process of open sourcing
 extension declaration and executing internal cleanups before it can be
 used externally.



?




?




?
"


?
%&


?
'E


?
(D
=
?
$/ Any features defined in the specific edition.


?



?



?


?
!#
@
?
?
0 The verification state of the extension range.



?

C
?
3 All the extensions of the range must be declared.



?


?



?




?



?

?

?
E~ The verification state of the range.
 TODO: flip the default to DECLARATION once all empty ranges
 are marked as UNVERIFIED.


?



?



?
)

?
,-

?
.D

?
9C
Z
?
M Clients can define custom options in extensions of this message. See above.


?




?



?

3
?
?
% Describes a field within a message.



?


?
?



?

S
?
C 0 is reserved for errors.
 Order is weird for historical reasons.



?


?



?




?



?

w
?
g Not ZigZag encoded.  Negative numbers take 10 bytes.  Use TYPE_SINT64 if
 negative values are likely.



?


?


?



?


?

w
?
g Not ZigZag encoded.  Negative numbers take 10 bytes.  Use TYPE_SINT32 if
 negative values are likely.



?


?


?



?


?


?



?


?


?



?


?


?



?


?

?
	?
? Tag-delimited aggregate.
 Group type is deprecated and not supported after google.protobuf. However, Proto3
 implementations should still be able to parse the group wire format and
 treat group fields as unknown fields.  In Editions, the group wire format
 can be enabled via the `message_encoding` feature.


	
?


	?

-

?
" Length-delimited aggregate.




?



?

#
?
 New in version 2.



?


?


?



?


?



?




?



?


?



?


?


?



?


?

'
?
" Uses ZigZag encoding.



?


?

'
?
" Uses ZigZag encoding.



?


?



?
?




?

*

?
 0 is reserved for errors




?



?




?





?




?

?


?
?
 The required label is only allowed in google.protobuf.  In proto3 and Editions
 it's explicitly prohibited.  In Editions, the `field_presence` feature
 can be used to get this behavior.




?



?


?

?


?


?

?


?


?



?



?


?

?

?


?


?

?
?

??
 If type_name is set, this need not be set.  If both this and type_name
 are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP.


?


?


?

?
?
? ? For message and enum types, this is the name of the type.  If the name
 starts with a '.', it is fully-qualified.  Otherwise, C++-like scoping
 rules are used to find the type (i.e. first the nested types within this
 message are searched, then within the parent, on up to the root
 namespace).


?


?


?

?
~
?p For extensions, this is the name of the type being extended.  It is
 resolved in the same manner as type_name.


?


?


?

?
?
?$? For numeric types, contains the original text representation of the value.
 For booleans, "true" or "false".
 For strings, contains the default text contents (not escaped in any way).
 For bytes, contains the C escaped value.  All bytes >= 128 are escaped.


?


?


?

?"#
?

?!v If set, gives the index of a oneof in the containing type's oneof_decl
 list.  This field is a member of that oneof.


?


?


?

? 
?

?!?
 JSON name of this field. The value is set by protocol compiler. If the
 user has set a "json_name" option on this field, that option's value
 will be used. Otherwise, it's deduced from the field's name by converting
 it to camelCase.


?


?


?

? 

	?$

	?


	?

	
?

	?"#
?	

?%?	 If true, this is a proto3 "optional". When a proto3 field is optional, it
 tracks presence regardless of field type.

 When proto3_optional is true, this field must be belong to a oneof to
 signal to old proto3 clients that presence is tracked for this field. This
 oneof is known as a "synthetic" oneof, and this field must be its sole
 member (each proto3 optional field gets its own synthetic oneof). Synthetic
 oneofs exist in the descriptor only, and do not generate any API. Synthetic
 oneofs must be ordered after all "real" oneofs.

 For message fields, proto3_optional doesn't create any semantic change,
 since non-repeated message fields always track presence. However it still
 indicates the semantic detail of whether the user wrote "optional" or not.
 This can be useful for round-tripping the .proto file. For consistency we
 give message fields a synthetic oneof also, even though it is not required
 to track presence. This is especially important because the parser can't
 tell if a field is a message or an enum, so it must always create a
 synthetic oneof.

 Proto2 optional fields do not set this flag, because they already indicate
 optional with `LABEL_OPTIONAL`.



?



?



?


?"$
"
??
 Describes a oneof.



?

?

?


?


?

?


?$


?



?



?


?"#
'
??
 Describes an enum type.



?

?

?


?


?

?


?.


?



?#



?$)


?,-

?#

?


?


?

?!"
?
??? Range of reserved numeric values. Reserved values may not be used by
 entries in the same enum. Reserved ranges may not overlap.

 Note that this is distinct from DescriptorProto.ReservedRange in that it
 is inclusive such that it can appropriately represent the entire int32
 domain.



?


?" Inclusive.


?

?



?

?


?" Inclusive.



?


?




?


?
?

?0?
 Range of reserved numeric values. Reserved numeric values may not be used
 by enum values in the same enum declaration. Reserved ranges may not
 overlap.


?


?


?+

?./
l
?$^ Reserved enum value names, which may not be reused. A given name may only
 be reserved once.


?


?


?

?"#
1
??
# Describes a value within an enum.



? 

?

?


?


?

?


?


?



?



?


?

?(

?


?


?#

?&'
$
??
 Describes a service.



?

?

?


?


?

?


?,


?



? 



?!'


?*+

?&

?


?


?!

?$%
0
	??
" Describes a method of a service.


	
?

	?

	?


	?

	
?

	?
?

	
?!?
 Input and output type names.  These are resolved in the same way as
 FieldDescriptorProto.type_name, but must refer to a message type.


	
?


	
?

	

?

	
? 

	?"

	?


	?

	
?

	? !

	?%

	?


	?

	
? 

	?#$
E
	?77 Identifies if client streams multiple client messages


	?


	?

	
? 

	?#$

	?%6

	?05
E
	?77 Identifies if server streams multiple server messages


	?


	?

	
? 

	?#$

	?%6

	?05
?

??
2N ===================================================================
 Options
2?
 Each of the definitions above may have "options" attached.  These are
 just annotations which may cause code to be generated slightly differently
 or may contain hints for code that manipulates protocol messages.

 Clients may define custom options as extensions of the *Options messages.
 These extensions may not yet be known at parsing time, so the parser cannot
 store the values in them.  Instead it stores them in a field in the *Options
 message called uninterpreted_option. This field must have the same name
 across all *Options messages. We then use this field to populate the
 extensions when we build a descriptor, at which point all protos have been
 parsed and so all extensions are known.

 Extension numbers for custom options may be chosen as follows:
 * For options which will only be used within a single application or
   organization, or for experimental options, use field numbers 50000
   through 99999.  It is up to you to ensure that you do not use the
   same number for multiple options.
 * For options which will be published and used publicly by multiple
   independent entities, e-mail [email protected]
   to reserve extension numbers. Simply provide your project name (e.g.
   Objective-C plugin) and your project website (if available) -- there's no
   need to explain how you intend to use them. Usually you only need one
   extension number. You can declare multiple options with only one extension
   number by putting them in a sub-message. See the Custom Options section of
   the docs for examples:
   https://developers.google.com/protocol-buffers/docs/proto#options
   If this turns out to be popular, a web service will be set up
   to automatically assign option numbers.




?
?


?#?
 Sets the Java package where classes generated from this .proto will be
 placed.  By default, the proto package is used, but this is often
 inappropriate because proto packages do not normally start with backwards
 domain names.



?



?



?


?!"
?


?+? Controls the name of the wrapper Java class generated for the .proto file.
 That class will always contain the .proto file's getDescriptor() method as
 well as any top-level extensions defined in the .proto file.
 If java_multiple_files is disabled, then all the other classes from the
 .proto file will be nested inside the single wrapper outer class.




?




?




?&



?)*
?

?;? If enabled, then the Java code generator will generate a separate .java
 file for each top-level message, enum, and service defined in the .proto
 file.  Thus, these types will *not* be nested inside the wrapper class
 named by java_outer_classname.  However, the wrapper class will still be
 generated to contain the file's getDescriptor() method as well as any
 top-level extensions defined in the file.



?



?



?#


?&(


?):


?49
)

?E This option does nothing.



?



?



?-


?02


?3D


?4C
?

?>? If set true, then the Java2 code generator will generate code that
 throws an exception whenever an attempt is made to assign a non-UTF-8
 byte sequence to a string field.
 Message reflection will do the same.
 However, an extension field still accepts non-UTF-8 byte sequences.
 This option has no effect on when used with the lite runtime.



?



?



?&


?)+


?,=


?7<
L

??< Generated classes can be optimized for speed or code size.




?
D

?"4 Generate complete code for parsing, serialization,




?	


?
G


? etc.
"/ Use ReflectionOps to implement these methods.





?



?
G

?"7 Generate code using MessageLite and the lite runtime.




?


?


?;


?



?



?$


?'(


?):


?49
?

?"? Sets the Go package where structs generated from this .proto will be
 placed. If omitted, the Go package will be derived from the following:
   - The basename of the package import path, if provided.
   - Otherwise, the package statement in the .proto file, if present.
   - Otherwise, the basename of the .proto file, without extension.



?



?



?


?!
?

?;? Should generic services be generated in each language?  "Generic" services
 are not specific to any particular RPC system.  They are generated by the
 main code generators in each language (without additional plugins).
 Generic services were the only kind of service generation supported by
 early versions of google.protobuf.

 Generic services are now considered deprecated in favor of using plugins
 that generate code specific to your particular RPC system.  Therefore,
 these default to false.  Old code which depends on generic services should
 explicitly set them to true.



?



?



?#


?&(


?):


?49


?=


?



?



?%


?(*


?+<


?6;


	?;


	?



	?


	
?#


	?&(


	?):


	?49



?<



?




?




?$



?')



?*;



?5:
?


?2?
 Is this file deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for everything in the file, or it will be completely ignored; in the very
 least, this is a formalization for deprecating files.



?



?



?


?


? 1


?+0


?7q Enables the use of arenas for the proto messages in this file. This applies
 only to generated classes for C++.



?



?



? 


?#%


?&6


?15
?



?)?
 Sets the objective c class prefix which is prepended to all objective c
 generated classes from this .proto. There is no default.




?




?




?#



?&(
I

?(; Namespace for generated classes; defaults to the package.



?



?



?"


?%'
?

?$? By default Swift generators will take the proto package and CamelCase it
 replacing '.' with underscore and use that to prefix the types/symbols
 defined. When this options is provided, they will use this value instead
 to prefix the types/symbols defined.



?



?



?


?!#
~

?(p Sets the php class prefix which is prepended to all php generated classes
 from this .proto. Default is empty.



?



?



?"


?%'
?


?%?
 Use this option to change the namespace of php generated classes. Default
 is empty. When this option is empty, the package name will be used for
 determining the namespace.



?



?



?


?"$
?


?.?
 Use this option to change the namespace of php generated metadata classes.
 Default is empty. When this option is empty, the proto file name will be
 used for determining the namespace.



?



?



?(


?+-
?


?$?
 Use this option to change the package of ruby generated classes. Default
 is empty. When this option is not set, the package name will be used for
 determining the ruby package.



?



?



?


?!#
=

?$/ Any features defined in the specific edition.



?



?



?


?!#
|

?:n The parser stores options it doesn't recognize here.
 See the documentation for the "Options" section above.



?



?



?3


?69
?


?z Clients can define custom options in extensions of this message.
 See the documentation for the "Options" section above.



?




?



?


	?


	?


	
?


	?

??



?
?
?>? Set true to use the old proto1 MessageSet wire format for extensions.
 This is provided for backwards-compatibility with the MessageSet wire
 format.  You should not use this for any other reason:  It's less
 efficient, has fewer features, and is more complicated.

 The message must be defined exactly as follows:
   message Foo {
     option message_set_wire_format = true;
     extensions 4 to max;
   }
 Note that the message cannot have any defined fields; MessageSets only
 have extensions.

 All extensions of your type must be singular messages; e.g. they cannot
 be int32s, enums, or repeated messages.

 Because this is an option, the above two restrictions are not enforced by
 the protocol compiler.


?


?


?'

?*+

?,=

?7<
?


?F?
 Disables the generation of the standard "descriptor()" accessor, which can
 conflict with a field of the same name.  This is meant to make migration
 from proto1 easier; new code should avoid fields named "descriptor".



?



?



?/


?23


?4E


??D
?

?1?
 Is this message deprecated?
 Depending on the target platform, this can emit Deprecated annotations
 for the message, or it will be completely ignored; in the very least,
 this is a formalization for deprecating messages.


?


?


?

?

?0

?*/

	?

	?

	
?

	?

	
?

	

?

	
?

	?

	
?

	?
?
?? NOTE: Do not set the option in .proto files. Always use the maps syntax
 instead. The option should only be implicitly set by the proto compiler
 parser.

 Whether the message is an automatically generated map entry type for the
 maps field.

 For maps fields:
     map map_field = 1;
 The parsed descriptor looks like:
     message MapFieldEntry {
         option map_entry = true;
         optional KeyType key = 1;
         optional ValueType value = 2;
     }
     repeated MapFieldEntry map_field = 1;

 Implementations may choose not to generate the map_entry=true message, but
 use a native map in the target language to hold the keys and values.
 The reflection APIs in such implementations still need to work as
 if the field is a repeated message field.


?


?


?

?
$
	?
" javalite_serializable


	?

	
?

	?

	?
" javanano_as_lite


	?

	
?

	?
?
?P? Enable the legacy handling of JSON field name conflicts.  This lowercases
 and strips underscored from the fields before comparison in proto3 only.
 The new behavior takes `json_name` into account and applies to proto2 as
 well.

 This should only be used as a temporary measure against broken builds due
 to the change in behavior for JSON field name conflicts.

 TODO This is legacy behavior we plan to remove once downstream
 teams have had time to migrate.


?


?


?6

?9;

?J




>
!
@ Executor type name


@


@


@

@


C" Display name



C



C



C


C !
#
F" Executor description


F


F


F

F !
:
I- Name of an icon in the Material Icons font.


I


I


I

I


LY




L
$
N An activity is runing



N	

N
b

RU The activity was cancelled. It may or may not still be running
 (verify stop time).




R


R
2
U% The activity completed successfully



U

U
<
X
/ An error occurred while running this activity



X

X



[d





[


] Info level




]


]	




` Warning level





`	



`


c
 Error level




c


c



fv




f

i.
 Log time


i


i$


i%)

i,-
?


o?
 Source of this log message. One of:

 - SERVICE: the log is generated by the activity service
 - ACTIVITY: the log is generated by the activity itself



o



o



o


o

r& Log level


r


r


r!

r$%

u
 Log message


u


u


u

u
?%
google/protobuf/duration.protogoogle.protobuf":
Duration
seconds
 
(Rseconds
nanos 
(RnanosB?

com.google.protobufB
DurationProtoP
Z1google.golang.org/protobuf/types/known/durationpb?

?GPB?Google.Protobuf.WellKnownTypesJ?#
r

?

2? Protocol Buffers - Google's data interchange format
 Copyright 2008 Google Inc.  All rights reserved.
 https://developers.google.com/protocol-buffers/

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:

     * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above
 copyright notice, this list of conditions and the following disclaimer
 in the documentation and/or other materials provided with the
 distribution.
     * Neither the name of Google Inc. nor the names of its
 contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.



 


"
	
"


#H
	
#H


$,
	

$,


%.
	
%.


&"
	

&"


'!
	
$'!


(;
	
%(;
?
er
? A Duration represents a signed, fixed-length span of time represented
 as a count of seconds and fractions of seconds at nanosecond
 resolution. It is independent of any calendar and concepts like "day"
 or "month". It is related to Timestamp in that the difference between
 two Timestamp values is a Duration and it can be added or subtracted
 from a Timestamp. Range is approximately +-10,000 years.

 # Examples

 Example 1: Compute Duration from two Timestamps in pseudo code.

     Timestamp start = ...;
     Timestamp end = ...;
     Duration duration = ...;

     duration.seconds = end.seconds - start.seconds;
     duration.nanos = end.nanos - start.nanos;

     if (duration.seconds < 0 && duration.nanos > 0) {
       duration.seconds += 1;
       duration.nanos -= 1000000000;
     } else if (duration.seconds > 0 && duration.nanos < 0) {
       duration.seconds -= 1;
       duration.nanos += 1000000000;
     }

 Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.

     Timestamp start = ...;
     Duration duration = ...;
     Timestamp end = ...;

     end.seconds = start.seconds + duration.seconds;
     end.nanos = start.nanos + duration.nanos;

     if (end.nanos < 0) {
       end.seconds -= 1;
       end.nanos += 1000000000;
     } else if (end.nanos >= 1000000000) {
       end.seconds += 1;
       end.nanos -= 1000000000;
     }

 Example 3: Compute Duration from datetime.timedelta in Python.

     td = datetime.timedelta(days=3, minutes=10)
     duration = Duration()
     duration.FromTimedelta(td)

 # JSON Mapping

 In JSON format, the Duration type is encoded as a string rather than an
 object, where the string ends in the suffix "s" (indicating seconds) and
 is preceded by the number of seconds, with nanoseconds expressed as
 fractional seconds. For example, 3 seconds with 0 nanoseconds should be
 encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
 be expressed in JSON format as "3.000000001s", and 3 seconds and 1
 microsecond should be expressed in JSON format as "3.000001s".





e
?

i?
 Signed seconds of the span of time. Must be from -315,576,000,000
 to +315,576,000,000 inclusive. Note: these bounds are computed from:
 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years


i


i

i
?

q? Signed fractions of a second at nanosecond resolution of the span
 of time. Durations less than one second are represented with a 0
 `seconds` field and a positive or negative `nanos` field. For durations
 of one second or more, a non-zero value for the `nanos` field must be
 of the same sign as the `seconds` field. Must be from -999,999,999
 to +999,999,999 inclusive.



q



q


qbproto3
??

&yamcs/protobuf/timeline/timeline.protoyamcs.protobuf.timelineyamcs/api/annotations.proto*yamcs/protobuf/activities/activities.protogoogle/protobuf/timestamp.protogoogle/protobuf/duration.proto"e
RelativeTime
relto
 
(	Rrelto?

relativeStart 
(2.google.protobuf.DurationR
relativeStart"?
TimelineItem
id
 
(	Rid
name 
(	Rname=
type 
(2).yamcs.protobuf.timeline.TimelineItemTypeRtype0
start 
(2.google.protobuf.TimestampRstart5
duration 
(2.google.protobuf.DurationRduration
tags (	Rtags
groupId 
(	RgroupIdI
relativeTime 
(2%.yamcs.protobuf.timeline.RelativeTimeRrelativeTime 
description	 
(	RdescriptionU

properties (25.yamcs.protobuf.timeline.TimelineItem.PropertiesEntryR
properties@
status
 
(2(.yamcs.protobuf.timeline.ExecutionStatusRstatus$

failureReason 
(	R
failureReasona
activityDefinition
 
(21.yamcs.protobuf.activities.ActivityDefinitionInfoRactivityDefinition
runs (	Rruns=
PropertiesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"t
LogEntry.
time
 
(2.google.protobuf.TimestampRtime
user 
(	Ruser
type 
(	Rtype
msg 
(	Rmsg"^
TimelineItemLog
id
 
(	Rid;
entries (2!.yamcs.protobuf.timeline.LogEntryRentries"?
TimelineBand
instance
 
(	Rinstance
id 
(	Rid
name 
(	Rname
username 
(	Rusername
shared 
(Rshared
source 
(	Rsource
tags (	B
Rtags=
filters (2#.yamcs.protobuf.timeline.ItemFilterRfilters=
type	 
(2).yamcs.protobuf.timeline.TimelineBandTypeRtype 
description
 
(	RdescriptionU

properties (25.yamcs.protobuf.timeline.TimelineBand.PropertiesEntryR
properties=
PropertiesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?

TimelineView
instance
 
(	Rinstance
id 
(	Rid
name 
(	Rname 
description 
(	Rdescription;
bands (2%.yamcs.protobuf.timeline.TimelineBandRbands"?
CreateItemRequest
instance
 
(	Rinstance
source 
(	Rsource
name 
(	Rname=
type 
(2).yamcs.protobuf.timeline.TimelineItemTypeRtype0
start 
(2.google.protobuf.TimestampRstart5
duration 
(2.google.protobuf.DurationRduration
tags (	Rtags
groupId 
(	RgroupIdI
relativeTime	 
(2%.yamcs.protobuf.timeline.RelativeTimeRrelativeTime 
description
 
(	RdescriptionZ

properties (2:.yamcs.protobuf.timeline.CreateItemRequest.PropertiesEntryR
propertiesa
activityDefinition 
(21.yamcs.protobuf.activities.ActivityDefinitionInfoRactivityDefinition=
PropertiesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"T
GetItemRequest
instance
 
(	Rinstance
source 
(	Rsource
id 
(	Rid"?
UpdateItemRequest
instance
 
(	Rinstance
source 
(	Rsource
id 
(	Rid
name 
(	Rname0
start 
(2.google.protobuf.TimestampRstart5
duration 
(2.google.protobuf.DurationRduration
tags (	Rtags
	clearTags 
(R	clearTags
groupId	 
(	RgroupIdI
relativeTime
 
(2%.yamcs.protobuf.timeline.RelativeTimeRrelativeTime@
status 
(2(.yamcs.protobuf.timeline.ExecutionStatusRstatus$

failureReason 
(	R
failureReasonZ

properties
 (2:.yamcs.protobuf.timeline.UpdateItemRequest.PropertiesEntryR
properties(
clearProperties 
(RclearProperties=
PropertiesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?
ListItemsRequest
instance
 
(	Rinstance
source 
(	Rsource
limit 
(Rlimit
next 
(	Rnext0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
band 
(	Rband=
filters (2#.yamcs.protobuf.timeline.ItemFilterRfilters
details	 
(Rdetails"W
DeleteItemRequest
instance
 
(	Rinstance
source 
(	Rsource
id 
(	Rid"W
GetItemLogRequest
instance
 
(	Rinstance
source 
(	Rsource
id 
(	Rid"?

AddItemLogRequest
instance
 
(	Rinstance
source 
(	Rsource
id 
(	Rid7
entry 
(2!.yamcs.protobuf.timeline.LogEntryRentry"`
DeleteTimelineGroupRequest
instance
 
(	Rinstance
source 
(	Rsource
id 
(	Rid"?

ListItemsResponse
source
 
(	Rsource;
items (2%.yamcs.protobuf.timeline.TimelineItemRitems,
continuationToken 
(	RcontinuationToken"?

TimelineSourceCapabilities
readOnly
 
(RreadOnly0
hasManualActivities 
(RhasManualActivities6
hasAutomatedActivities 
(RhasAutomatedActivities&
hasEventGroups 
(RhasEventGroups,
hasActivityGroups 
(RhasActivityGroups"0
ListSourcesRequest
instance
 
(	Rinstance"?

ListSourcesResponseS
sources
 (29.yamcs.protobuf.timeline.ListSourcesResponse.SourcesEntryRsourceso
SourcesEntry
key
 
(	RkeyI
value 
(23.yamcs.protobuf.timeline.TimelineSourceCapabilitiesRvalue:8
"M
ListTimelineTagsRequest
instance
 
(	Rinstance
source 
(	Rsource".
ListTimelineTagsResponse
tags
 (	Rtags"?
AddBandRequest
instance
 
(	Rinstance
name 
(	Rname
shared 
(Rshared
source 
(	Rsource
tags (	B
Rtags=
filters (2#.yamcs.protobuf.timeline.ItemFilterRfilters=
type 
(2).yamcs.protobuf.timeline.TimelineBandTypeRtype 
description 
(	RdescriptionW

properties	 (27.yamcs.protobuf.timeline.AddBandRequest.PropertiesEntryR
properties=
PropertiesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"<
GetBandRequest
instance
 
(	Rinstance
id 
(	Rid"?
UpdateBandRequest
instance
 
(	Rinstance
id 
(	Rid
name 
(	Rname 
description 
(	Rdescription
shared 
(Rshared
tags (	RtagsZ

properties (2:.yamcs.protobuf.timeline.UpdateBandRequest.PropertiesEntryR
properties
source 
(	Rsource=
filters	 (2#.yamcs.protobuf.timeline.ItemFilterRfilters=
PropertiesEntry
key
 
(	Rkey
value 
(	Rvalue:8
".
ListBandsRequest
instance
 
(	Rinstance"?
DeleteBandRequest
instance
 
(	Rinstance
id 
(	Rid"P
ListBandsResponse;
bands
 (2%.yamcs.protobuf.timeline.TimelineBandRbands"x
AddViewRequest
instance
 
(	Rinstance
name 
(	Rname 
description 
(	Rdescription
bands (	Rbands"<
GetViewRequest
instance
 
(	Rinstance
id 
(	Rid".
ListViewsRequest
instance
 
(	Rinstance"?

UpdateViewRequest
instance
 
(	Rinstance
id 
(	Rid
name 
(	Rname 
description 
(	Rdescription
bands (	Rbands"?
DeleteViewRequest
instance
 
(	Rinstance
id 
(	Rid"P
ListViewsResponse;
views
 (2%.yamcs.protobuf.timeline.TimelineViewRviews"?


ItemFilterO
criteria
 (23.yamcs.protobuf.timeline.ItemFilter.FilterCriterionRcriteria9
FilterCriterion
key
 
(	Rkey
value 
(	Rvalue*O
TimelineItemType	
EVENT

ACTIVITY

ITEM_GROUP
ACTIVITY_GROUP*W
ExecutionStatus
PLANNED

IN_PROGRESS
	COMPLETED
ABORTED

FAILED*O
TimelineBandType

TIME_RULER

	ITEM_BAND

SPACER
COMMAND_BAND2?
TimelineApi?


CreateItem*.yamcs.protobuf.timeline.CreateItemRequest%.yamcs.protobuf.timeline.TimelineItem"'??#/api/timeline/{instance}/items:
*?

GetItem'.yamcs.protobuf.timeline.GetItemRequest%.yamcs.protobuf.timeline.TimelineItem")??%
#/api/timeline/{instance}/items/{id}?


UpdateItem*.yamcs.protobuf.timeline.UpdateItemRequest%.yamcs.protobuf.timeline.TimelineItem",??(#/api/timeline/{instance}/items/{id}:
*?

	ListItems).yamcs.protobuf.timeline.ListItemsRequest*.yamcs.protobuf.timeline.ListItemsResponse"$?? 
/api/timeline/{instance}/items?


DeleteItem*.yamcs.protobuf.timeline.DeleteItemRequest%.yamcs.protobuf.timeline.TimelineItem")??%"#/api/timeline/{instance}/items/{id}?


GetItemLog*.yamcs.protobuf.timeline.GetItemLogRequest(.yamcs.protobuf.timeline.TimelineItemLog"-??)
'/api/timeline/{instance}/items/{id}/log?


AddItemLog*.yamcs.protobuf.timeline.AddItemLogRequest!.yamcs.protobuf.timeline.LogEntry"-??)'/api/timeline/{instance}/items/{id}/log?

DeleteTimelineGroup3.yamcs.protobuf.timeline.DeleteTimelineGroupRequest%.yamcs.protobuf.timeline.TimelineItem"*??&"$/api/timeline/{instance}/groups/{id}?

ListSources+.yamcs.protobuf.timeline.ListSourcesRequest,.yamcs.protobuf.timeline.ListSourcesResponse"&??"
 /api/timeline/{instance}/sources?

ListTags0.yamcs.protobuf.timeline.ListTimelineTagsRequest1.yamcs.protobuf.timeline.ListTimelineTagsResponse"#??
/api/timeline/{instance}/tags?

AddBand'.yamcs.protobuf.timeline.AddBandRequest%.yamcs.protobuf.timeline.TimelineBand"'??#/api/timeline/{instance}/bands:
*?

GetBand'.yamcs.protobuf.timeline.GetBandRequest%.yamcs.protobuf.timeline.TimelineBand")??%
#/api/timeline/{instance}/bands/{id}?

	ListBands).yamcs.protobuf.timeline.ListBandsRequest*.yamcs.protobuf.timeline.ListBandsResponse"$?? 
/api/timeline/{instance}/bands?


UpdateBand*.yamcs.protobuf.timeline.UpdateBandRequest%.yamcs.protobuf.timeline.TimelineBand",??(#/api/timeline/{instance}/bands/{id}:
*?


DeleteBand*.yamcs.protobuf.timeline.DeleteBandRequest%.yamcs.protobuf.timeline.TimelineBand")??%"#/api/timeline/{instance}/bands/{id}?

AddView'.yamcs.protobuf.timeline.AddViewRequest%.yamcs.protobuf.timeline.TimelineView"'??#/api/timeline/{instance}/views:
*?

GetView'.yamcs.protobuf.timeline.GetViewRequest%.yamcs.protobuf.timeline.TimelineView")??%
#/api/timeline/{instance}/views/{id}?

	ListViews).yamcs.protobuf.timeline.ListViewsRequest*.yamcs.protobuf.timeline.ListViewsResponse"$?? 
/api/timeline/{instance}/views?


UpdateView*.yamcs.protobuf.timeline.UpdateViewRequest%.yamcs.protobuf.timeline.TimelineView",??(#/api/timeline/{instance}/views/{id}:
*?


DeleteView*.yamcs.protobuf.timeline.DeleteViewRequest%.yamcs.protobuf.timeline.TimelineView")??%"#/api/timeline/{instance}/views/{id}B%
org.yamcs.protobufB
TimelineProtoP
Jҥ

?






 


+
	

+


.
	
.


"
	

"
	
%
	

4
	
	)
	

(
6

?

)Methods related to the Timeline Service.







 Create an item





"

-9



?2



 Get an item










'3





?2

$ Update an item





"

-9

 #

?2 #

'+ List items



'

' 

'+<

(*

?2(*

.2 Delete an item



.

."

.-9

/1

?2/1

59 Get an item log



5

5"

5-<

68

?268
?

=A?
add an entry to the item log table
 The timestamp from the messages is used if specified; if not specified, the current mission time will be used 



=

="

=-5

>@

?2>@

DH Delete a group



D

D4

D?K

EG

?2EG
?

NR?
 List timeline sources

 Usually there is a source named 'rdb' which provides items from an internal RocksDB database.
 Other external sources may be created by adding plugins (e.g. a shift planner)



N

N$

N/B

OQ

?2OQ
?

	X\?
 List all tags available for the 'rdb' source.

 Note that currently the 'rdb' source does not discard unused tags
 (e.g. if all item using one tag have been deleted, the tag will still be returned by this call)


	
X

	X&

	X1I

	Y[

	?2Y[


_d Add a band




_


_


_'3


`c


?2`c

gk Get a band



g

g

g'3

hj

?2hj

nr List all bands



n

n 

n+<

oq

?2oq


uz Update a band




u


u"


u-9


vy


?2vy

}?
 Delete a band



}

}"

}-9

~?


?2~?


?
?
 Add a view



?


?


?
'3

?
?


?2?
?


?
?
 Get a view



?


?


?
'3

?
?


?2?
?

 
?
?
 List all views



?


?
 

?
+<

?
?


?2?
?


?
?
 Update a view



?


?
"

?
-9

?
?


?2?
?


?
?
 Delete a view



?


?
"

?
-9

?
?


?2?
?


?
?




?

E
?
7 Identifier of the item that this time is relative to.


?



?



?


?



?
6


?




?
#



?
$1


?
45

?
?




?

:
?
, Events are the most generic timeline item.



?


?


B

?
4 Unlike events, activities have an execution status




?




?


D
?
6 A grouping of other items (events and/or activities)



?


?

I
?
; A grouping of activities. The group is itself an activity



?


?

/

?
?

! Execution status of an activity




?



?




?
	


?




?





?




?



?




?



?



?




?
	


?



?




?



?



?
?





?

?

?
? Item identifier.

 The identifier is set and recognized by the source.
 It is possible but unlikely that two items coming from two different sources will have the same id.

 The rdb source sets the id to a UUID. 
 The commands source sets the id to the command id



?




?




?



?




?
 Item name




?





?





?




?



?
%


?




?




?
 


?
#$


?
/


?




?
$



?
%*


?
-.


?
1


?




?
#



?
$,


?
/0


?



?




?




?



?

M

?
? If this item is part of a group, this is the group identifier



?




?




?



?

?

?
)? If this item time specification is relative to another item, ``relativeTime``
 contains a reference to that item as well as the relative start (the duration
 is the same as the ``duration`` field).

 Note that start of the item is computed by the server based on the
 ``relativeTime`` before sending the item to the client.



?




?




?
$


?
'(
 

?
" Item description



?




?




?



?
 !
K

	?
&= Additional properties used by yamcs-web to render this item



	?



	
?
 


	?
#%
0


?
'" For activities: execution status




?





?





?
!



?
$&
?


?
%?
 For activities: if the status is FAILED or ABORTED, this may indicate the reason
 some information may also be available in the item log 



?




?




?



?
"$
Z

?
TL Activity definition associated to this item.
 Set if ``type`` is ACTIVITY.



?




?
;



?
 Item duration. Applies also if ``relativeTime`` is specified


?


?#


?$,

?/0

? Tags


?


?


?

?
M
?? If this item is part of a group, this is the group identifier


?


?


?

?
?

?)?
 If the item time specification is relative to another item,
 ``relativeTime`` contains a reference to that item, as well
 as the relative start (the duration is the same as given by the
 ``duration`` field).


?


?


?$

?'(
 
	?# Item description


	?


	?

	
?

	? "
K

?&= Additional properties used by yamcs-web to render this item



?



? 


?#%
_
?TQ Activity definition associated to this item.
 Required if ``type`` is ACTIVITY.


?


?;


?
:/api/buckets/{instance}/{bucketName}/objects/{objectName*}0
?


GetObjectInfo,.yamcs.protobuf.buckets.GetObjectInfoRequest".yamcs.protobuf.buckets.ObjectInfo"@??<
:/api/storage/buckets/{bucketName}/objectInfo/{objectName*}?

UploadObject+.yamcs.protobuf.buckets.UploadObjectRequest.google.protobuf.Empty"?
???
8/api/storage/buckets/{bucketName}/objects/{objectName**}:data@???ZJ;/api/buckets/{instance}/{bucketName}/objects/{objectName**}0
:data@????

ListObjects*.yamcs.protobuf.buckets.ListObjectsRequest+.yamcs.protobuf.buckets.ListObjectsResponse"s??o
)/api/storage/buckets/{bucketName}/objectsRobjectsZ9
,/api/buckets/{instance}/{bucketName}/objects0
Robjects?

DeleteObject+.yamcs.protobuf.buckets.DeleteObjectRequest.google.protobuf.Empty"}??y"7/api/storage/buckets/{bucketName}/objects/{objectName*}Z>":/api/buckets/{instance}/{bucketName}/objects/{objectName*}0
B$
org.yamcs.protobufBBucketsProtoP
J?N
?









+
	

+


-
	
-


"
	

"
	
%
	

	)
	
%
	
"
?
%?

? Methods related to object storage.

 Buckets represent a simple mechanism for storing user objects (binary data
 chunks such as images, monitoring lists, displays...) together with some
 metadata.

 The metadata is represented by simple (key,value) pairs where both key and
 value are strings.

 By default each user has a bucket named ``user.username`` which can be used
 without extra privileges. Additional buckets may be created and used if the
 user has the required privileges. The user bucket will be created
 automatically when the user tries to access it.

 The following limitations are implemented in order to prevent disk over
 consumption and keep the service responsive:

 *   The maximum size of an upload including data and metadata is 5MB.
 *   The maximum number of objects in one bucket is 1000.
 *   The maximum size of an bucket 100MB (counted as the sum of the size of
     the objects within the bucket).
 *   The maximum size of the metadata is 16KB (counted as the sum of the
     length of the keys and values).




%

(0 List buckets



(

($

(/B

)/

?2)/


3; Get a bucket




3


3 


3+5


4:


?24:

>H Create a bucket



>

>&

>1;

?G

?2?G
h
MUZ Delete a bucket

 Deleting a bucket means also deleting all objects that are part of it.



M

M&

M1F

NT

?2NT
?
^f? Get an object

 The body of the response represents the object data. The ``Content-Type``
 header is set to the content type of the object specified when uploading
 the object. If no ``Content-Type`` was specified when creating the object,
 the ``Content-Type`` of the response is set to
 ``application/octet-stream``.



^

^ 

^+=

_e

?2_e

im Get object info



i

i(

i3=

jl

?2jl
?
?
?
? Upload an object

 .. rubric:: Simple upload
 
 In case of simple upload, the objectName has to be specified as part of the URL
 and the ``Content-Type header`` has to be set to the type of the object. The body
 of the request is the object data.
 
 
 .. rubric:: Form upload
 
 The form based upload can be used to upload an object from an HTML form. In this
 case the Content-Type of the request is set to ``multipart/form-data``, and the
 body will contain at least one part which is the object data. This part includes
 a filename which is used as the object name as well as a ``Content-Type`` header.
 The name attribute for the file part is ignored.
 Additional parts (which do not specify a filename) will be used as metadata: the
 name is specified as part of the ``Content-Disposition`` and the value is the body
 of the part.
 
 This can be tested with curl using the ``-F`` option.
 
 
 .. rubric:: Example
 .. code-block:: http
 
     POST /api/storage/buckets/my_bucket/objects HTTP/1.1
     Host: localhost:8090
     User-Agent: curl/7.58.0
     Accept: */*
     Content-Length: 1090
     Content-Type: multipart/form-data; boundary=------------------------7109c709802f7ae4
 
     --------------------------7109c709802f7ae4
     Content-Disposition: form-data; name="file"; filename="object/name"
     Content-Type: text/plain
 
     [object data]
     --------------------------7109c709802f7ae4
     Content-Disposition: form-data; name="name1"
 
     value1
     --------------------------7109c709802f7ae4
     Content-Disposition: form-data; name="name2"
 
     value2
     --------------------------7109c709802f7ae4--
 
 
 This will create an object named ``object/name`` with two metadata properties:
 
 .. code-block:: json
 
     {
         "name1": "value1",
         "name2": "value2"
     }



?


?
&

?
1F

?
?


?2?
?


?
?
 List objects



?


?
$

?
/B

?
?


?2?
?

"
?
?
 Delete an object



?


?
&

?
1F

?
?


?2?
?


?
?




?

0
?
3" Yamcs instance name. Or _global.


?



?



?


?


?
2

?
 1


?

 Bucket name



?




?




?



?



?
?





?

0

?
3" Yamcs instance name. Or _global.



?




?




?



?



?
2


?
 1



?
!
 Bucket name




?





?





?




?
 

?
?




?

0
?
3" Yamcs instance name. Or _global.


?



?



?


?


?
2

?
 1


?
!
 Bucket name



?




?




?



?
 

?
!
 Object name


?



?



?


?
 

?
?




?


?
!
 Bucket name


?



?



?


?
 


?
!
 Object name



?




?




?



?
 

?
?




?

0
?
3" Yamcs instance name. Or _global.


?



?



?


?


?
2

?
 1


?
!
 Bucket name



?




?




?



?
 

?
!
 Object name


?



?



?


?
 

?
?



?

0
?
3" Yamcs instance name. Or _global.


?



?



?


?


?
2

?
 1
?


?!?
 Bucket name.

 If the bucketName is ``user.username`` the bucket will be created automatically
 if it does not exist. Otherwise the bucket must exist before being used.



?



?



?


? 

?!
 Object name


?


?


?

? 

?'

?


?


?"

?%&

??



?

?
 Bucket name


?


?


?

?
Z

?L Total size in bytes of all objects in the bucket (metadata is not counted)



?



?



?


?
/
?!! Number of objects in the bucket


?


?


?

? 
9
?+ Maximum allowed total size of all objects


?


?


?

?
1
?!# Maximum allowed number of objects


?


?


?

? 
,
?1 Creation time of this bucket


?


?$


?%,

?/0
?

? ?
 Bucket root directory. This field is only set when the
 bucket is mapped to the file system. Therefore it is not
 set for buckets that store objects in RocksDB.


?


?


?

?

?' Bucket location


?


?


?"

?%&

??



?

? Location name


?


?


?

?
$

?" Location description



?



?



?


? !

??



?

?
 Object name


?


?


?

?


?1 Creation time



?



?$



?%,


?/0

? Size in bytes


?


?


?

?

?# Object metadata


?


?

?!"

?" Content type


?


?


?

? !

	??


	
?
0
	?3" Yamcs instance name. Or _global.


	?


	?

	
?

	?

	?2

	? 1


??




?
0

?3" Yamcs instance name. Or _global.



?



?



?


?


?2


? 1



?!
 Bucket name




?




?




?



? 

??



?

?"

?


?


?

? !

??



?
0
?3" Yamcs instance name. Or _global.


?


?


?

?

?2

? 1


?!
 Bucket name



?



?



?


? 
?
? ? Return only objects whose name do not contain the delimiter after the
 prefix. For the other objects, the response contains (in the prefix
 response parameter) the name truncated after the delimiter. Duplicates
 are omitted.

 Together with ``prefix`` this parameter provides filtering capabilities.
 These work similar to Google Cloud Storage and Amazon S3.

 The ``delimiter`` allows the list to work in a directory mode despite
 the object namespace being flat. For example if the delimiter is set to
 "/", then listing the bucket containing objects "a/b", "a/c", "d", "e"
 and "e/f" returns objects "d" and "e" and prefixes "a/" and "e/".


?


?


?

?
>
?0 List only objects whose name start with prefix


?


?


?

?


??




?
?


?w Object name prefixes for objects that matched the request but were
 excluded from ``objects`` because of a delimiter.



?



?



?


?
#


?" The list of objects




?




?




?



? !
?N
yamcs/protobuf/cop1/cop1.protoyamcs.protobuf.cop1yamcs/api/annotations.protogoogle/protobuf/empty.protogoogle/protobuf/timestamp.proto"?

InitializeRequest
instance
 
(	Rinstance
link 
(	Rlink;
type 
(2'.yamcs.protobuf.cop1.InitializationTypeRtype>
clcwCheckInitializeTimeout 
(RclcwCheckInitializeTimeout
vR 
(
RvR"?

UpdateConfigRequest
instance
 
(	Rinstance
link 
(	Rlink?

cop1Config 
(2.yamcs.protobuf.cop1.Cop1ConfigR
cop1Config"B
GetConfigRequest
instance
 
(	Rinstance
link 
(	Rlink"B
GetStatusRequest
instance
 
(	Rinstance
link 
(	Rlink"?

ResumeRequest
instance
 
(	Rinstance
link 
(	Rlink"d
DisableRequest
instance
 
(	Rinstance
link 
(	Rlink"
setBypassAll 
(RsetBypassAll"?

Clcw@

receptionTime
 
(2.google.protobuf.TimestampR
receptionTime
lockout 
(Rlockout
wait 
(Rwait

retransmit 
(R
retransmit
nR 
(
RnR"?

Cop1Status
link 
(	Rlink

cop1Active
 
(R
cop1Active"
setBypassAll 
(RsetBypassAll-
clcw 
(2.yamcs.protobuf.cop1.ClcwRclcw4
state 
(2.yamcs.protobuf.cop1.Cop1StateRstate
vS 
(
RvS
nnR 
(
RnnR&
waitQueueNumTC 
(
RwaitQueueNumTC.
sentQueueNumFrames 
(
RsentQueueNumFrames,
outQueueNumFrames	 
(
RoutQueueNumFrames
txCount
 
(
RtxCount"?


Cop1Config
vcId
 
(
RvcId.
bdAbsolutePriority 
(RbdAbsolutePriority 
windowWidth 
(
RwindowWidthB
timeoutType 
(2 .yamcs.protobuf.cop1.TimeoutTypeRtimeoutType
txLimit 
(
RtxLimit
t1 
(Rt1"H
SubscribeStatusRequest
instance
 
(	Rinstance
link 
(	Rlink*Y
InitializationType
WITH_CLCW_CHECK

WITHOUT_CLCW_CHECK

UNLOCK

SET_VR*?

	Cop1State

ACTIVE

RETRANSMIT_WITHOUT_WAIT
RETRANSMIT_WITH_WAIT
INITIALIZING_WITHOUT_BC
INITIALIZING_WITH_BC

UNINITIALIZED
	SUSPENDED*,
TimeoutType
UNINITIALIZE
SUSPEND
2?
Cop1Api}

Initialize&.yamcs.protobuf.cop1.InitializeRequest.google.protobuf.Empty"/??+&/api/cop1/{instance}/{link}:initialize:
*n
Resume".yamcs.protobuf.cop1.ResumeRequest.google.protobuf.Empty"(??$"/api/cop1/{instance}/{link}:resumet
Disable#.yamcs.protobuf.cop1.DisableRequest.google.protobuf.Empty",??(#/api/cop1/{instance}/{link}:disable:
*?

UpdateConfig(.yamcs.protobuf.cop1.UpdateConfigRequest.yamcs.protobuf.cop1.Cop1Config"4??0*"/api/cop1/{instance}/{link}/config:
cop1Config}
	GetConfig%.yamcs.protobuf.cop1.GetConfigRequest.yamcs.protobuf.cop1.Cop1Config"(??$
"/api/cop1/{instance}/{link}/config}
	GetStatus%.yamcs.protobuf.cop1.GetStatusRequest.yamcs.protobuf.cop1.Cop1Status"(??$
"/api/cop1/{instance}/{link}/statusm
SubscribeStatus+.yamcs.protobuf.cop1.SubscribeStatusRequest.yamcs.protobuf.cop1.Cop1Status"
ڒ
cop10
	??
COP-1B!
org.yamcs.protobufB	Cop1ProtoP
J?8
?










+
	

+


*
	
*


"
	

"
	
%
	

%
	
	)
?
J
? Methods for virtual channel TC links that have ``useCop1: true``.
 This service contains methods for setting/getting the configuration and
 performing various operations.
 In addition, a websocket subscription is available that will allow receiving periodically the status.







%

?%
=
/ Initialize COP-1 in case state is UNITIALIZED





"

-B



?2
A

 3 Resume COP-1 operation in case state is SUSPENDED











%:





?2
?

',?
 Disable COP-1 operation

 This causes the sent queue to be purged.
 All TCs from the wait queue, as well as newly received TCs
 are sent immediately



'

'

''<

(+

?2(+
-
/4 Update configuration settings



/

/&

/1;

03

?203
'
7; Get COP-1 configuration



7

7 

7+5

8:

?28:
 
>B Get COP-1 status



>

> 

>+5

?A

?2?A
,
EI Receive COP-1 status updates



E

E,

E7=

E>H

FH

?2FH


LY




L
W
OJ CLCW will be expected from the remote system and used to initiate the vS



O

O
0

R# Initiate without waiting for CLCW




R


R
M
U
@ This causes a BC Unlock frame to be sent to the remote system.



U

U
d
X
W Initiate AD with set V(R). This will cause a BC frame to be sent to the remote system



X

X


[i




[
#
] Yamcs instance name.


]


]


]

]


` Link name.



`



`



`


`

b'

b


b


b"

b%&
E
e18 Timeout in milliseconds for initialize with CLCW check


e


e


e,

e/0
3
h&vR value for initialize with set V(R)


h


h


h

h



ks





k
#

m Yamcs instance name.



m



m



m


m



p Link name.




p




p




p



p


r%


r



r



r 


r#$


u{




u
#
w Yamcs instance name.


w


w


w

w


z Link name.



z



z



z


z

~?





~
$
?
 Yamcs instance name.


?



?



?


?



?
 Link name.



?




?




?



?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
 Link name.



?




?




?



?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
 Link name.



?




?




?



?

`
?
!R If true, all transmitted frames while COP1 is disabled, have the bypass flag set


?



?



?


?
 


?
?





?



?




?



?




?





?




?



?




?



?



?




?



?



?




?



?



?




?



?



?




?



?


?
?




?


?
8

?



?
$


?
%2

?
56


?



?




?




?



?


?


?



?



?


?


?


?



?



?


?


?


?



?



?


?


?
?




?

?

?
?
 Link name for which this status applies. 
 It is present when this message is sent over the websocket as there might
 be multiple COP-1 links subscribed


?



?



?


?

Y

?
K If false, all frames are immediately transmitted (i.e. COP-1 is disabled)



?




?




?



?

]
?
!O Relevant if cop1Active = false -> set the bypass flag on all outgoing frames 


?



?



?


?
 
"
?
 Last received CLCW


?



?



?


?

X
?
J Current state of FOP-1 state machine, only relevant if cop1Active = true


?



?



?


?

9
?
+ V(S) - Transmitter Frame Sequence Number;


?



?



?


?

-
?
 The nR from the previous CLCW


?



?



?


?

6
?
%( Number of TC packets in the wait queue


?



?



?
 

?
#$
A
?
)3 Number of unacknowledged frames in the sent queue


?



?



?
$

?
'(
l
	?
(^ Number of frames in the out queue (waiting to be picked up by the master chain
 multiplexer)


	?



	?


	
?
#

	?
&'
B

?
4 How many times the last frame has been transmitted



?




?




?



?


?
?




?


?



?


?



?




?
	


?


?
?




?


?


?



?



?


?

_

?
'Q If true, the BD frames are sent immediately, without going to the waiting queue



?




?




?
"


?
%&
{
?
"m Maximum size of the sent queue (i.e. how many unacknowledged frames can be in the
 queue before timing out)


?



?



?


?
 !
S
?
'E What should happen on timeout: go to SUSPEND or go to UNINITIALIZED


?



?



?
"

?
%&
K
?
= How many times the frames are transmitted before timing out


?



?



?


?

E
?
7 How many milliseconds to wait between retransmissions


?



?



?


?


	?
?



	
?

$
	?
 Yamcs instance name.


	?



	?


	
?


	?


	
?
 Link name.


	
?



	
?


	

?


	
?

?
 yamcs/protobuf/audit/audit.protoyamcs.protobuf.auditgoogle/protobuf/struct.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.proto"?

ListAuditRecordsRequest
instance
 
(	Rinstance
limit 
(Rlimit
next 
(	Rnext0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop

q 
(	R
q
service 
(	Rservice"?

ListAuditRecordsResponse;
records
 (2!.yamcs.protobuf.audit.AuditRecordRrecords,
continuationToken 
(	RcontinuationToken"?

AuditRecord.
time
 
(2.google.protobuf.TimestampRtime
service 
(	Rservice
method 
(	Rmethod
user 
(	Ruser
summary 
(	Rsummary1
request 
(2.google.protobuf.StructRrequest2?

AuditApi?

ListAuditRecords-.yamcs.protobuf.audit.ListAuditRecordsRequest..yamcs.protobuf.audit.ListAuditRecordsResponse"#??
/api/audit/records/{instance}B/
org.yamcs.protobuf.auditBAuditServiceProtoP
J?
C









1
	

1


2
	
2


"
	

"
	
&
	

	)
	
%










"
 List audit records





.

9Q



?2


0





"
 Yamcs instance name











?


?
 The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``















G
!: Continuation token returned by a previous page response.


!


!


!

!

%/r Filter the lower bound of the record's time. Specify a date string in
 ISO 8601 format. This bound is inclusive.


%


%$


%%*

%-.

).r Filter the upper bound of the record's time. Specify a date string in
 ISO 8601 format. This bound is exclusive.


)


)$


)%)

),-
1
,$ Text to search for in the summary.


,


,


,

,
C
/6 Include only records matching the specified service.


/


/


/

/



2:





2 
)

4# Page with matching records



4



4



4


4!"
?



9(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.




9




9




9#



9&'


<C




<

=.

=


=$


=%)

=,-


>


>



>



>


>

?

?


?


?

?

@

@


@


@

@

A

A


A


A

A

B.

B


B!


B")

B,-
?'
"yamcs/protobuf/config/config.protoyamcs.protobuf.configgoogle/protobuf/struct.proto"?
SpecInfo;
options
 (2!.yamcs.protobuf.config.OptionInfoRoptions*
allowUnknownKeys 
(RallowUnknownKeysL

requiredOneOf (2&.yamcs.protobuf.config.OptionGroupInfoR
requiredOneOfP
requireTogether (2&.yamcs.protobuf.config.OptionGroupInfoRrequireTogetherP
whenConditions (2(.yamcs.protobuf.config.WhenConditionInfoRwhenConditions"%
OptionGroupInfo
keys
 (	Rkeys"w
WhenConditionInfo
key
 
(	Rkey,
value 
(2.google.protobuf.ValueRvalue"
requiredKeys (	RrequiredKeys"?

OptionInfo
name
 
(	Rname5
type 
(2!.yamcs.protobuf.config.OptionTypeRtype
title 
(	Rtitle0
default 
(2.google.protobuf.ValueRdefault
required 
(Rrequired
hidden 
(Rhidden
secret 
(Rsecret"
versionAdded 
(	RversionAdded.
deprecationMessage	 
(	RdeprecationMessage 
description
 (	RdescriptionC
elementType 
(2!.yamcs.protobuf.config.OptionTypeRelementType3
spec 
(2.yamcs.protobuf.config.SpecInfoRspec0
choices
 (2.google.protobuf.ValueRchoices,
applySpecDefaults 
(RapplySpecDefaults
aliases (	Raliases*n

OptionType
ANY

BOOLEAN
INTEGER	
FLOAT
LIST
LIST_OR_ELEMENT
MAP

STRINGB*
org.yamcs.protobuf.configBConfigProtoP
J?
l









2
	

2


,
	
,


"
	

"
	
&

















	






	









	

















	















	







B
'
6 Specifies the valid structure of a configuration map





/
"" Options for this specification  










 !
-

%  If true, any option is allowed











 


#$
n
-a Constraints on a groups of options. For each group at least one
 of the keys must be specified.








(

+,
n
#/a Constraints on a group of options. For each group, all keys must
 be specified, or none at all.


#


#


#*

#-.
<
&0/ Conditional constraints on a group of options


&


&


&+

&./



),





)


+
 Option keys



+



+



+


+


.7




.
4
0' Option key for checking the condition


0


0


0

0
$

3+ Value to compare with



3



3 



3!&


3)*
P
6#C Option keys that must be specified, if the condition is satisfied


6


6


6

6!"


9l




9
8
;+ Name of this option, unique within a spec


;


;


;

;
"

> Type of this option



>



>



>


>
0
A# UI-friendly label for this option


A


A


A

A
=
D-0 Default value when the option is not specified


D


D 


D!(

D+,
5
G( Whether this options must be specified


G


G


G

G
U
KH Hint that this option should be excluded from any
 document generation


K


K


K

K
D
O7 Hint that value for this option should not be
 logged


O


O


O

O
}
S#p Which version of this software this option was added.
 Can be the Yamcs version, or the version of a plugin.  


S


S


S

S!"
2
V)% Deprecation message for this option


V


V


V$

V'(
B
	Y#5 Description, each list entry represents a paragraph


	Y


	Y

	
Y

	Y "
v

]'i When the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type
 of each element of that list



]



]



]!


]$&
a
aT When the type or elementType is ``MAP``, this specifies
 the options with that map


a


a


a

a
-
d.  Allowed values for this option


d


d 


d!(

d+-
?


h'?
 When the type is ``MAP``, this property determines whether default values
 are generated even when a value for that option was not provided.



h



h



h!


h$&
@
k3 Additional names that can be used for this option


k


k


k

k
?
$yamcs/protobuf/actions/actions.protoyamcs.protobuf.actions"yamcs/protobuf/config/config.proto"?


ActionInfo
id
 
(	Rid
label 
(	Rlabel
style 
(	Rstyle
enabled 
(Renabled
checked 
(Rchecked3
spec 
(2.yamcs.protobuf.config.SpecInfoRspecB,
org.yamcs.protobuf.actionsBActionsProtoP
J?










3
	

3


-
	
-


"
	

"
	
,










 
 Action identifier











)

 Label describing an action















D
7 Action style, one of ``PUSH_BUTTON`` or ``CHECK_BOX``











7
* Whether this action is currently enabled











7
* Whether this action is currently checked











7
3* Specification of action options (if any)





)


*.

12
̹

.yamcs/protobuf/filetransfer/filetransfer.protoyamcs.protobuf.filetransfergoogle/protobuf/timestamp.protogoogle/protobuf/empty.protogoogle/protobuf/struct.protoyamcs/api/annotations.proto$yamcs/protobuf/actions/actions.proto"a

TransactionId&
sequenceNumber
 
(
RsequenceNumber(
initiatorEntity 
(RinitiatorEntity"=
ListFileTransferServicesRequest
instance
 
(	Rinstance"]
GetFileTransferServiceRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName"t
 ListFileTransferServicesResponseP
services
 (24.yamcs.protobuf.filetransfer.FileTransferServiceInfoRservices"?
FileTransferCapabilities
upload
 
(Rupload
download 
(Rdownload

remotePath 
(R
remotePath
fileList 
(RfileList(
hasTransferType 
(RhasTransferType 
pauseResume	 
(RpauseResume`
fileListExtraColumns (2,.yamcs.protobuf.filetransfer.ExtraColumnInfoRfileListExtraColumnsD
fileActions (2".yamcs.protobuf.actions.ActionInfoRfileActions"7
ExtraColumnInfo
id
 
(	Rid
label 
(	Rlabel"?
FileTransferServiceInfo
instance
 
(	Rinstance
name 
(	RnameM

localEntities (2'.yamcs.protobuf.filetransfer.EntityInfoR
localEntitiesO
remoteEntities (2'.yamcs.protobuf.filetransfer.EntityInfoRremoteEntitiesY
capabilities 
(25.yamcs.protobuf.filetransfer.FileTransferCapabilitiesRcapabilitiesY
transferOptions (2/.yamcs.protobuf.filetransfer.FileTransferOptionRtransferOptions"0

EntityInfo
name
 
(	Rname
id 
(Rid"?
TransferInfo
id
 
(Rid8
	startTime 
(2.google.protobuf.TimestampR	startTime@
state 
(2*.yamcs.protobuf.filetransfer.TransferStateRstate
bucket 
(	Rbucket

objectName 
(	R
objectName

remotePath 
(	R
remotePathL
	direction 
(2..yamcs.protobuf.filetransfer.TransferDirectionR	direction
	totalSize 
(R	totalSize(
sizeTransferred	 
(RsizeTransferred
reliable
 
(Rreliable$

failureReason 
(	R
failureReasonP

transactionId 
(2*.yamcs.protobuf.filetransfer.TransactionIdR
transactionId>
creationTime
 
(2.google.protobuf.TimestampRcreationTime"
transferType 
(	RtransferTypeI
localEntity 
(2'.yamcs.protobuf.filetransfer.EntityInfoRlocalEntityK
remoteEntity 
(2'.yamcs.protobuf.filetransfer.EntityInfoRremoteEntity"?
CreateTransferRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceNameL
	direction 
(2..yamcs.protobuf.filetransfer.TransferDirectionR	direction
bucket 
(	Rbucket

objectName 
(	R
objectName

remotePath 
(	R
remotePath
source	 
(	Rsource 
destination
 
(	Rdestination1
options 
(2.google.protobuf.StructRoptions"d
PauseTransferRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName
id 
(Rid"e
CancelTransferRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName
id 
(Rid"e
ResumeTransferRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName
id 
(Rid"?
ListTransfersRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop$

localEntityId 
(R
localEntityId&
remoteEntityId 
(RremoteEntityId@
state (2*.yamcs.protobuf.filetransfer.TransferStateRstateL
	direction 
(2..yamcs.protobuf.filetransfer.TransferDirectionR	direction
limit	 
(Rlimit
order
 
(	Rorder"b
GetTransferRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName
id 
(Rid"`
ListTransfersResponseG
	transfers
 (2).yamcs.protobuf.filetransfer.TransferInfoR	transfers"{
SubscribeTransfersRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName 
ongoingOnly 
(RongoingOnly"?

ListFilesRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName
source 
(	Rsource 
destination 
(	Rdestination

remotePath 
(	R
remotePath1
options 
(2.google.protobuf.StructRoptions"?


RemoteFile
name
 
(	Rname 
displayName 
(	RdisplayName 
isDirectory 
(RisDirectory
size 
(Rsize6
modified 
(2.google.protobuf.TimestampRmodified-
extra 
(2.google.protobuf.StructRextra"?
ListFilesResponse=
files
 (2'.yamcs.protobuf.filetransfer.RemoteFileRfiles 
destination 
(	Rdestination

remotePath 
(	R
remotePath6
listTime 
(2.google.protobuf.TimestampRlistTime
state 
(	Rstate(
progressMessage 
(	RprogressMessage"?

RunFileActionRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName"
remoteEntity 
(	RremoteEntity
file 
(	Rfile
action 
(	Raction1
message 
(2.google.protobuf.StructRmessage"?
FileTransferOption
name
 
(	RnameH
type 
(24.yamcs.protobuf.filetransfer.FileTransferOption.TypeRtype
title 
(	Rtitle 
description 
(	Rdescription&
associatedText 
(	RassociatedText
default 
(	RdefaultM
values (25.yamcs.protobuf.filetransfer.FileTransferOption.ValueRvalues,
allowCustomOption 
(RallowCustomOption?
Value
value
 
(	Rvalue 
verboseName 
(	RverboseName"+
Type
BOOLEAN

DOUBLE


STRING*-
TransferDirection

UPLOAD

DOWNLOAD*_

TransferState
RUNNING


PAUSED

FAILED
	COMPLETED

QUEUED

CANCELLING2?
FileTransferApi?

ListFileTransferServices<.yamcs.protobuf.filetransfer.ListFileTransferServicesRequest=.yamcs.protobuf.filetransfer.ListFileTransferServicesResponse"+??'
%/api/filetransfer/{instance}/services?

GetFileTransferService:.yamcs.protobuf.filetransfer.GetFileTransferServiceRequest4.yamcs.protobuf.filetransfer.FileTransferServiceInfo"9??5
3/api/filetransfer/{instance}/services/{serviceName}?


ListTransfers1.yamcs.protobuf.filetransfer.ListTransfersRequest2.yamcs.protobuf.filetransfer.ListTransfersResponse":??6
4/api/filetransfer/{instance}/{serviceName}/transfers?

GetTransfer/.yamcs.protobuf.filetransfer.GetTransferRequest).yamcs.protobuf.filetransfer.TransferInfo"???;
9/api/filetransfer/{instance}/{serviceName}/transfers/{id}?

CreateTransfer2.yamcs.protobuf.filetransfer.CreateTransferRequest).yamcs.protobuf.filetransfer.TransferInfo"=??94/api/filetransfer/{instance}/{serviceName}/transfers:
*?


PauseTransfer1.yamcs.protobuf.filetransfer.PauseTransferRequest.google.protobuf.Empty"E??A?/api/filetransfer/{instance}/{serviceName}/transfers/{id}:pause?

CancelTransfer2.yamcs.protobuf.filetransfer.CancelTransferRequest.google.protobuf.Empty"F??B@/api/filetransfer/{instance}/{serviceName}/transfers/{id}:cancel?

ResumeTransfer2.yamcs.protobuf.filetransfer.ResumeTransferRequest.google.protobuf.Empty"F??B@/api/filetransfer/{instance}/{serviceName}/transfers/{id}:resume?

SubscribeTransfers6.yamcs.protobuf.filetransfer.SubscribeTransfersRequest).yamcs.protobuf.filetransfer.TransferInfo"ڒ
file-transfers0
?

SubscribeRemoteFileList6.yamcs.protobuf.filetransfer.SubscribeTransfersRequest..yamcs.protobuf.filetransfer.ListFilesResponse"ڒ
remote-file-list0
?


FetchFileList-.yamcs.protobuf.filetransfer.ListFilesRequest.google.protobuf.Empty">??:5/api/filetransfer/{instance}/{serviceName}/files:sync:
*?

GetFileList-.yamcs.protobuf.filetransfer.ListFilesRequest..yamcs.protobuf.filetransfer.ListFilesResponse"=??9
0/api/filetransfer/{instance}/{serviceName}/filesRfiles?


RunFileAction1.yamcs.protobuf.filetransfer.RunFileActionRequest.google.protobuf.Struct"G??C>/api/filetransfer/{instance}/{serviceName}/files:runFileAction:
*B)
org.yamcs.protobufBFileTransferProtoP
J?~
?






$


+
	

+


2
	
2


"
	

"
	
)
	

	%
	

&
	
%
	

.
?

x
2?
 This API deals with transmission (upload and download) of file to and from spacecraft.
 The API can be used to interface any implementation of the FileTransferService.
 One such implementation is for the CFDP - CCSDS File Delivery Protocol.





+
 List file transfer services





>

Ii



?2
+

! Get a file transfer service







:


E\


 


?2 

$( List transfers



$

$(

$3H

%'

?2%'

+/ Get a transfer



+

+$

+/;

,.

?2,.
!
27 Create a transfer



2

2*

25A

36

?236
 
:> Pause a transfer



:

:(

:3H

;=

?2;=
w
DHi Cancel a transfer

 The ongoing transfer is aborted, partially uploaded/downloaded files
 are retained.



D

D*

D5J

EG

?2EG
!
KO Resume a transfer



K

K*

K5J

LN

?2LN
-
RV Subscribe to transfer updates



R

R2

R=C

RDP

SU

?2SU
5
	Y]' Subscribe to remote file list updates


	
Y

	Y7

	YBH

	YIZ

	Z\

	?2Z\
-

`e Request file list from remote




`


`$


`/D


ad


?2ad
$
hm Get latest file list



h

h"

h->

il

?2il
q
rwc Run a file-specific action.

 Available actions are specific to the File Transfer implementation.



r

r(

r3I

sv

?2sv


z}




z

{


{

{


|



|



|



?









?




?
	


?




?





?




?



?




?



?



?




?



?



?




?



?



?




?



?


?
?




?


?
%

?



?



?
 

?
#$


?
&


?




?




?
!


?
$%


?
?





?
'
#

?
 Yamcs instance name



?




?




?



?


?
?




?
%
#
?
 Yamcs instance name


?



?



?


?

*

?
" File transfer service name



?




?




?



?
 !

?
?




?
(

?
0

?



?
"


?
#+

?
./

?
?




?
 
=
?
/ Whether the transfer service supports uploads


?



?



?


?

?

?
1 Whether the transfer service supports downloads



?




?




?



?

O
?
A Whether the transfer service supports specifying an upload path


?



?



?


?

J
?
< Whether the transfer service supports remote file listings


?



?



?


?

O
?
$A Whether transfers contain a column describing the Transfer Type


?



?



?


?
"#
B
?
 4 Whether the transfer service supports pause/resume


?



?



?


?

h
?
4Z Additional columns to show in a file listing, where id
 is a key of ``RemoteFile.extra``


?



?



?
/

?
23
G
?
=9 Additional actions that may be executed on remote files


?



?
,


?
-8

?
;<

?
?




?


?


?



?



?


?



?



?




?




?



?


?
?




?

#
?
 Yamcs instance name


?



?



?


?

*

?
 File transfer service name



?




?




?



?


?
(

?



?



?
#

?
&'

?
)

?



?



?
$

?
'(

?
5

?



?
#


?
$0

?
34

?
2

?



?



?
-

?
01

?
?




?


?


?



?



?


?



?



?




?




?



?


?
?




?

F
?
8unique identifier assigned by the file transfer service


?



?



?


?

b

?
3Twhen the transfer has started. Note that this will not be set for QUEUED transfers.



?




?
$



?
%.


?
12

?
#

?



?



?


?
!"

?


?



?



?


?


?
!

?



?



?


?
 

?
!

?



?



?


?
 

?
+

?



?



?
&

?
)*

?
 

?



?



?


?


?
&

?



?



?
!

?
$%
W
	?
Ireliable = true -> class 2 transfer
reliable = false -> class 1 transfer


	?



	?


	
?


	?

P

?
%Bin case the transcation is failed, this provides more information



?




?




?



?
"$
?

?
,?
 valid for CFDP: transaction id;
 for the incoming transfers it is assigned by the remote peer so therefore might not be unique


?



?



?
&

?
)+
4
?
7& when the transfer has been created. 


?



?
$


?
%1

?
46
?


?
$x depending on the implementation, can mean normal file transfer, directory listing request, file download request, etc.



?




?




?



?
!#
L
?
'> Local entity, may be empty if there is only one such entity.


?



?



?
!

?
$&
M
?
(? Remote entity, may be empty if there is only one such entity.


?



?



?
"

?
%'

	?
?


	
?

#
	?
 Yamcs instance name


	?



	?


	
?


	?

*
	
?
" File transfer service name


	
?



	
?


	

?


	
?
 !
?
	?+1 **Required** One of ``UPLOAD`` or ``DOWNLOAD``.


	?


	?

	
?&

	?)*
J
	?< **Required** The bucket containing the local Yamcs object.


	?


	?

	
?

	?
?
	?!? **Required** The object name in Yamcs bucket storage. For UPLOAD transfers,
 this object must exist and is what Yamcs will transfer to the remote
 entity. For DOWNLOAD transfers, it refers to the object that
 Yamcs will write to when downloading from a remote entity.


	?


	?

	
?

	? 
d
	?!V **Required** The path at the remote entity. Example: ``a/local/path/some_filename``.


	?


	?

	
?

	? 
2
	?$used to derive the source entity id


	?


	?

	
?

	?
7
	?#)used to derive the destination entity id


	?


	?

	
?

	? "
(
	?/ Options for the transfer


	?


	?!

	
?")

	?,.


??




?
#

? Yamcs instance name



?



?



?


?
*


?" File transfer service name




?




?




?



? !
7

?) Transfer identifier (assigned by Yamcs)



?



?



?


?

??



?
#
? Yamcs instance name


?


?


?

?
*

?" File transfer service name



?



?



?


? !
7
?) Transfer identifier (assigned by Yamcs)


?


?


?

?

??



?
#
? Yamcs instance name


?


?


?

?
*

?" File transfer service name



?



?



?


? !
7
?) Transfer identifier (assigned by Yamcs)


?


?


?

?


??




?
#

? Yamcs instance name



?



?



?


?
*


?" File transfer service name




?




?




?



? !
?


?/~ Filter the lower bound of the transfer's creation time.
 Specify a date string in ISO 8601 format. This bound is
 inclusive.



?



?$



?%*


?-.
?


?.~ Filter the upper bound of the transfer's creation time.
 Specify a date string in ISO 8601 format. This bound is
 exclusive.



?



?$



?%)


?,-
1

?## Filter by local entity identifier



?



?



?


?!"
2

?$$ Filter by remote entity identifier



?



?



?


?"#
D

?#6 Filter by transfer state. Leave empty to return any.



?



?



?


?!"
A

?+3 Filter by transfer direction (UPLOAD or DOWNLOAD)



?



?



?&


?)*
?


??
 The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``



?



?



?


?
h

	?Z The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``



	?



	?


	
?


	?

??



?
#
? Yamcs instance name


?


?


?

?
*

?" File transfer service name



?



?



?


? !
7
?) Transfer identifier (assigned by Yamcs)


?


?


?

?

??



?

?&

?


?


?!

?$%

??



?!
#
? Yamcs instance name


?


?


?

?
*

?" File transfer service name



?



?



?


? !
?
? ? If true, send info on all currently ongoing transfers,
 as well as any future updates (recommended).

 For legacy reasons, the default is ``false``, which will
 send also finished transfers upon subscription. This behaviour
 is due for removal in a future release (if you want to receive
 past transfers, do a GET request).


?


?


?

?

??



?
#
? Yamcs instance name


?


?


?

?
*

?" File transfer service name



?



?



?


? !
6
?( Entity from which to get the file list


?


?


?

?
6
?"( Entity from which to get the file list


?


?


?

? !
1
?!# Path of folder to list files from


?


?


?

? 
(
?. Options for the transfer


?


?!


?")

?,-

??



?
m
?_ File identifier

 Typically, a remote file path, or a filename
 in case of a flat file table.


?


?


?

?
?


?"w Optional display name. Can be used when the ``name``
 field contains information that should be hidden from the user.



?



?



?


? !
7
? ) True if the path represents a directory


?


?


?

?

? File size


?


?


?

?
!
?2 Modification time


?


?$


?%-

?01
.
?,  Implementation-specific fields


?


?!


?"'

?*+

??



?

? 

?


?


?

?


?"


?



?



?


? !

?!

?


?


?

? 

?2

?


?$


?%-

?01

?

?


?


?

?
L
?&> Progress message, in case the file listing is still underway


?


?


?!

?$%

??



?
#
? Yamcs instance name


?


?


?

?
*

?" File transfer service name



?



?



?


? !

?# Remote entity


?


?


?

?!"

? File identifier


?


?


?

?

?
 Action name


?


?


?

?

?. Action message


?


?!


?")

?,-
2
??
$
CUSTOMISABLE FILE TRANSFER OPTIONS



?

??


?
-
? Shown as checkbox in the UI



?

?
M

?= Shown as a number field or drop-down if values is specified




?



?

I
?9 Shown as text field or drop-down if values is specified



?


?


? Identifier


?


?


?

?


?
 Option type



?



?



?


?
$
? Title for the option


?


?


?

?
(
?" Help text shown on hover


?


?


?

? !
?
?%1 Placeholder for fields and label for checkboxes


?


?


? 

?#$
+
? Default value for the field


?


?


?

?
2
?$ Values for potential dropdown menu


?


?


?

?
N
?&@ Whether a custom field is needed when using the drop-down menu


?


?


?!

?$%

??


?

H
?8 Real value for the option (used to sent to the server)


?

?



?

?
,

?$ Display name for the value



?


?




?


?"#
?O
yamcs/protobuf/yamcs.protoyamcs.protobufgoogle/protobuf/timestamp.proto"?
Value.
type
 (2.yamcs.protobuf.Value.TypeRtype

floatValue 
(R
floatValue 
doubleValue 
(
RdoubleValue 
sint32Value 
(Rsint32Value 
uint32Value 
(
Ruint32Value 
binaryValue 
(RbinaryValue 
stringValue 
(	RstringValue&
timestampValue 
(RtimestampValue 
uint64Value	 
(Ruint64Value 
sint64Value
 
(Rsint64Value"
booleanValue 
(RbooleanValueF
aggregateValue 
(2.yamcs.protobuf.AggregateValueRaggregateValue5

arrayValue
 (2.yamcs.protobuf.ValueR
arrayValue"?

Type	
FLOAT

DOUBLE


UINT32

SINT32

BINARY

STRING
	TIMESTAMP

UINT64

SINT64
BOOLEAN	
	AGGREGATE
	
ARRAY

ENUMERATED
NONE
"Q
AggregateValue
name
 (	Rname+
value (2.yamcs.protobuf.ValueRvalue"A

NamedObjectId
name
 (	Rname
	namespace 
(	R	namespace"D
NamedObjectList1
list
 (2.yamcs.protobuf.NamedObjectIdRlist"?

ArchiveRecord-
id
 
(2.yamcs.protobuf.NamedObjectIdRid
num 
(Rnum
seqFirst 
(RseqFirst
seqLast 
(RseqLast0
first 
(2.google.protobuf.TimestampRfirst.
last	 
(2.google.protobuf.TimestampRlast>
extra
 (2(.yamcs.protobuf.ArchiveRecord.ExtraEntryRextra8

ExtraEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?

ReplaySpeed?
type
 (2+.yamcs.protobuf.ReplaySpeed.ReplaySpeedTypeRtype
param 
(Rparam"L
ReplaySpeedType
AFAP

FIXED_DELAY
REALTIME
STEP_BY_STEP"?

ReplayRequest0
start
 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop=
	endAction 
(2.yamcs.protobuf.EndAction:QUITR	endAction1
speed 
(2.yamcs.protobuf.ReplaySpeedRspeed
reverse 
(RreverseR
parameterRequest 
(2&.yamcs.protobuf.ParameterReplayRequestRparameterRequestI

packetRequest	 
(2#.yamcs.protobuf.PacketReplayRequestR
packetRequestF
eventRequest
 
(2".yamcs.protobuf.EventReplayRequestReventRequesta
commandHistoryRequest 
(2+.yamcs.protobuf.CommandHistoryReplayRequestRcommandHistoryRequest=
	ppRequest 
(2.yamcs.protobuf.PpReplayRequestR	ppRequest"
	autostart 
(:trueR	autostart"?

ParameterReplayRequest=

nameFilter
 (2.yamcs.protobuf.NamedObjectIdR
nameFilter
sendRaw 
(:falseRsendRaw3
performMonitoring 
(:falseRperformMonitoring"n
PacketReplayRequest=

nameFilter
 (2.yamcs.protobuf.NamedObjectIdR
nameFilter
tmLinks (	RtmLinks"
EventReplayRequest"\
CommandHistoryReplayRequest=

nameFilter
 (2.yamcs.protobuf.NamedObjectIdR
nameFilter"g
PpReplayRequest(
groupNameFilter
 (	RgroupNameFilter*
groupNameExclude (	RgroupNameExclude"?
ReplayStatus>
state
 (2(.yamcs.protobuf.ReplayStatus.ReplayStateRstate7
request 
(2.yamcs.protobuf.ReplayRequestRrequest"
errorMessage 
(	RerrorMessage"^
ReplayState
INITIALIZATION
RUNNING

STOPPED	
ERROR

PAUSED

CLOSED*)
	EndAction
LOOP

QUIT
STOPB
org.yamcs.protobufJ?7
?










+
	

+
	
)
,
'
  Union type for storing a value






	


	






	
















































































	

	


	














	


a
R Enumerated values have both an integer (sint64Value) and a string representation






























 















"









 !

"









 !

"









 !

!









 

 "

 


 


 

  !

!$

!


!


!

!"#

""

"


"


"

" !

	##

	#


	#

	
#

	# "


$"


$



$



$


$!

%.

%


%


%(

%+-

&!

&


&


&

& 
?


,/
?
 An aggregate value is an ordered list of (member name, member value).
 Two arrays are used in order to be able to send just the values (since
 the names will not change)





,


-


-


-



-


-



.



.



.




.



.
?

47
?
 Used by external clients to identify an item in the Mission Database
 If namespace is set, then the name is that of an alias, rather than
 the qualified name.




4

5

5


5


5

5


6 


6



6



6


6


9;




9

:"

:


:


:

: !
$
>F
contains histogram data




>

? 

?


?


?

?


@


@



@



@


@

A

A


A


A

A

B

B


B


B

B

C/

C


C$


C%*

C-.

D.

D


D$


D%)

D,-

E!

E


E

E 


HL




H

I


I

I	



J



J


J	


K


K

K	



NW




N

OT


O

P


P

P


Q



Q


Q

R


R

R

S


S

S

U$

U


U


U

U"#


V


V



V



V


V
L
Zw
@used to replay (concurrently) TM packets, parameters and events




Z
H
\0; **Required.** The time at which the replay should start. 


\


\$


\%*

\-/
?


`/| The time at which the replay should stop.
 If unspecified, the replay will keep going as long  as there is remaining data.



`



`$



`%)


`,.
9
c1,what should happen at the end of the replay


c


c


c

c!"

c"0

c+/
+
f!how fast the replay should go


f


f


f

f 
2
i% Reverse the direction of the replay


i


i


i

i

k7

k


k!


k"2

k56
?

o1?
 By default all Packets, Events, CommandHistory are part of the replay
 Unless one or more of the below requests are specified.


o


o


o,

o/0

p0

p


p


p*

p-/

qB

q


q&


q'<

q?A

	r*

	r


	r

	
r$

	r')
Z

v.M Start the replay following initialization
 Defaults to true, if unspecified



v



v



v


v


v-


v(,


y}




y
,
z(" At least 1 filter is required


z


z


z#

z&'


{+


{



{



{


{


{*


{$)
(
|5"i.e. out of limit checking


|


|


|!

|$%

|%4

|.3

?






Q
?
(C No filter, means all packets for which privileges exist, are sent


?



?



?
#

?
&'
Z

?
Lif specified, only replay packets originally received on one of those links



?




?




?



?


	?
?



	
?



?
?





?
#
E

?
(7 No filter, means all command history entries are sent



?




?




?
#


?
&'
Y
?
?

KRequest to replay parameters - they can be filtered by the parameter group



?

7
?
&) No filter, means all pp groups are sent


?



?



?
!

?
$%
?


?
'?
 exclude the parameters from these groups
   this takes precedence over the filter above (i.e. if a group is part of both, it will be excluded)



?




?




?
"


?
%&

?
?




?


?
?



?

l
?
\ just at the beginning or when the replay request (start, stop or packet selection) changes



?


?



?




?



?

H
?
8 The replay has reached the end with the endaction stop



?


?

5
?
% The replay stopped due to an error.



?
	

?


?



?



?


3
?
# The replay is finished and closed



?



?



?
!

?



?



?


?
 


?
%


?




?




?
 


?
#$
&
?
# In case state is ERROR


?



?



?


?
!"
?
&yamcs/protobuf/services/services.protoyamcs.protobuf.services"?
ServiceInfo
instance
 
(	Rinstance
name 
(	Rname;
state 
(2%.yamcs.protobuf.services.ServiceStateRstate
	className 
(	R	className
	processor 
(	R	processor&
failureMessage 
(	RfailureMessage"
failureCause 
(	RfailureCause*\
ServiceState
NEW
STARTING

RUNNING
STOPPING

TERMINATED

FAILEDB%
org.yamcs.protobufB
ServicesProtoP
J?
6






 


+
	

+


.
	
.


"
	

"


	




	
"
 Yamcs instance name













 Service name
















" Service state










 !

  Java class name











C
 6 Processor name (in case this is a processor service)











<
%/ Short failure message when `state` is FAILED.








 

#$
1
#$ Stacktrace when `state` is FAILED.










!"
I
!6
=service states coming from guava (numbers have to correspond)



!
i
$
\ A service in this state is inactive. It does minimal work and
 consumes minimal resources.



$

$	
G

': A service in this state is transitioning to ``RUNNING``.




'



'

6
*) A service in this state is operational.



*	

*
J
-= A service in this state is transitioning to ``TERMINATED``.



-


-

~
1q A service in this state has completed execution normally.
 It does minimal work and consumes minimal resources.



1

1

5
r A service in this state has encountered a problem and may
 not be operational. It cannot be started nor stopped.



5

5
?<
4yamcs/protobuf/yamcsManagement/yamcsManagement.protoyamcs.protobuf.yamcsManagementgoogle/protobuf/timestamp.protoyamcs/protobuf/yamcs.proto&yamcs/protobuf/services/services.proto"?

ProcessorInfo
instance
 
(	Rinstance
name 
(	Rname
type 
(	Rtype
spec 
(	Rspec
creator 
(	Rcreator
	hasAlarms 
(R	hasAlarms$

hasCommanding 
(R
hasCommanding;
state 
(2%.yamcs.protobuf.services.ServiceStateRstateC

replayRequest	 
(2.yamcs.protobuf.ReplayRequestR
replayRequestJ
replayState
 
(2(.yamcs.protobuf.ReplayStatus.ReplayStateRreplayState@
services (2$.yamcs.protobuf.services.ServiceInfoRservices

persistent 
(R
persistent.
time 
(2.google.protobuf.TimestampRtime
replay 
(Rreplay4
checkCommandClearance 
(RcheckCommandClearance
	protected 
(R	protected\
acknowledgments (22.yamcs.protobuf.yamcsManagement.AcknowledgmentInfoRacknowledgments"J
AcknowledgmentInfo
name
 
(	Rname 
description 
(	Rdescription"?
TmStatistics

packetName
 
(	R
packetName$

qualifiedName	 
(	R
qualifiedName(
receivedPackets 
(RreceivedPackets:
subscribedParameterCount 
(RsubscribedParameterCount>
lastReceived
 
(2.google.protobuf.TimestampRlastReceivedB
lastPacketTime 
(2.google.protobuf.TimestampRlastPacketTime

packetRate 
(R
packetRate
dataRate
 
(RdataRateJJJJ	"?


Statistics
instance
 
(	Rinstance
	processor 
(	R	processorF
tmstats (2,.yamcs.protobuf.yamcsManagement.TmStatisticsRtmstats<
lastUpdated 
(2.google.protobuf.TimestampRlastUpdatedJJJ"?
ProcessorManagementRequestb
	operation
 
(2D.yamcs.protobuf.yamcsManagement.ProcessorManagementRequest.OperationR	operation
instance 
(	Rinstance
name 
(	Rname
type 
(	Rtype
config 
(	Rconfig%

persistent 
(:falseR
persistent";
	Operation
CREATE_PROCESSOR
CONNECT_TO_PROCESSOR
"?
ProcessorRequestX
	operation
 
(2:.yamcs.protobuf.yamcsManagement.ProcessorRequest.OperationR	operation
instance 
(	Rinstance
name 
(	Rname
seekTime 
(RseekTime=
replaySpeed 
(2.yamcs.protobuf.ReplaySpeedRreplaySpeed">
	Operation	
PAUSE

RESUME
SEEK
CHANGE_SPEED"?

StreamEventD
type
 
(20.yamcs.protobuf.yamcsManagement.StreamEvent.TypeRtype
name 
(	Rname
	dataCount 
(R	dataCount"-
Type
CREATED

DELETED
UPDATEDB,
org.yamcs.protobufBYamcsManagementProtoP
J?(
?







'


+
	

+


5
	
5


"
	

"
	
)
	


$
	
0



'






#
 Yamcs instance name.













 Processor name.
































































"









 !

+




 


!&

)*

+"in case of replay








&

)*

	5"in case of replay


	


	#

	
$/

	24


.










 (


+-

 











/




$


%)

,.


















+







%

(*
:
"- If true, this processor can not be deleted.


"


"


"

"
?

&3t Globally available acknowledgments (in addition to Acknowledge_Queued,
 Acknowledge_Released and Acknowledge_Sent)


&


&


&-

&02



)/





)
"

+ Acknowledgment name



+



+



+


+
0


."# Description of the acknowledgment




.




.




.



. !


1>




1


	2

	2

	
2

	2

	
2


	

2


	
2


	2

	
2

	2

	2

	
2

	2

5! Packet name.


5


5


5

5 


7$


7



7



7


7"#

8%

8


8


8 

8#$

9.

9


9


9)

9,-

:7

:


:$


:%1

:46

;9

;


;$


;%3

;68

<!

<


<


<

< 

=

=


=


=

=


@J




@


	A

	A

	
A

	A

	
A


	

A


	
A


	A

	
A

	A
#
C Yamcs instance name.


C


C


C

C


F  Processor name.



F



F



F


F

H$

H


H


H

H"#
0
I5"#java local time of the last update


I


I$


I%0

I34


LW




L"

MP


M

N


N

N


O



O


O

Q#

Q


Q


Q

Q!"


R"yamcs instance



R



R



R


R

S"processor name


S


S


S

S

T"only for CREATE


T


T


T

T
6
U")only for CREATE - used to be called spec


U


U


U

U

V."only for CREATE


V


V


V

V

V-

V',


Yu




Y

Zf


Z
$
\ Pause the processor



\	

\
%

_ Resume the processor




_



_

(
b
 Seek to a specific time



b

b
,
e Change speed of a processor



e

e
;
h#. Which operation to perform with this request


h


h


h

h!"
"

k Yamcs instance name



k



k



k


k

n Processor name


n


n


n

n
E
q8 Time to seek to, when ``operation`` is set to ``SEEK``


q


q


q

q
C
t'6 Speec, shen ``operation`` is set to ``CHANGE_SPEED``


t


t


t"

t%&

w?





w

x?



x
)
z A new stream was created



z

z
%

} A stream was deleted




}


}
-
?
 A stream's info was updated



?


?


?
 Event type


?



?



?


?



?

 Stream name



?




?




?



?

 
?
 Number of tuples


?



?



?


?

?
.yamcs/protobuf/services/services_service.protoyamcs.protobuf.servicesgoogle/protobuf/empty.protoyamcs/api/annotations.proto&yamcs/protobuf/services/services.proto"1
ListServicesRequest
instance
 
(	Rinstance"C
GetServiceRequest
instance
 
(	Rinstance
name 
(	Rname"E
StartServiceRequest
instance
 
(	Rinstance
name 
(	Rname"D
StopServiceRequest
instance
 
(	Rinstance
name 
(	Rname"X
ListServicesResponse@
services
 (2$.yamcs.protobuf.services.ServiceInfoRservices2?
ServicesApi?

ListServices,.yamcs.protobuf.services.ListServicesRequest-.yamcs.protobuf.services.ListServicesResponse"??
/api/services/{instance}?


GetService*.yamcs.protobuf.services.GetServiceRequest$.yamcs.protobuf.services.ServiceInfo"%??!
/api/services/{instance}/{name}?

StartService,.yamcs.protobuf.services.StartServiceRequest.google.protobuf.Empty"+??'%/api/services/{instance}/{name}:start~
StopService+.yamcs.protobuf.services.StopServiceRequest.google.protobuf.Empty"*??&$/api/services/{instance}/{name}:stopB,
org.yamcs.protobufBServicesServiceProtoP
J?
O






 


+
	

+


5
	
5


"
	

"
	
%
	


%
	
0


.






 List services





&

1E



?2


 Get a service







"


-8





?2

# Start a service





&

1F

 "

?2 "
?

)-z Stop a service

 Once stopped, a service cannot be resumed. Instead a new service
 instance will be created and started.



)

)$

)/D

*,

?2*,


03




0
I
2< Yamcs instance name. Or _global for system-wide services. 


2


2


2

2



5;





5
H

7; Yamcs instance name. Or _global for system-wide services.



7



7



7


7



: Service name




:




:




:



:


=C




=
H
?; Yamcs instance name. Or _global for system-wide services.


?


?


?

?


B Service name



B



B



B


B


EK




E
H
G; Yamcs instance name. Or _global for system-wide services.


G


G


G

G


J Service name



J



J



J


J


MO




M

N$

N


N


N

N"#
??
yamcs/protobuf/mdb/mdb.protoyamcs.protobuf.mdbyamcs/api/annotations.protoyamcs/api/httpbody.protoyamcs/protobuf/yamcs.proto"?
MissionDatabase

configName
 
(	R
configName
name 
(	Rname
version 
(	RversionI
spaceSystem (2#.yamcs.protobuf.mdb.SpaceSystemInfoB
RspaceSystemG
spaceSystems (2#.yamcs.protobuf.mdb.SpaceSystemInfoRspaceSystems&
parameterCount 
(RparameterCount&
containerCount 
(RcontainerCount"
commandCount 
(RcommandCount&
algorithmCount	 
(RalgorithmCount.
parameterTypeCount
 
(RparameterTypeCount"m
HistoryInfo
version
 
(	Rversion
date 
(	Rdate
message 
(	Rmessage
author 
(	Rauthor"
UnitInfo
unit
 
(	Runit"?


AlarmRange8
level
 
(2".yamcs.protobuf.mdb.AlarmLevelTypeRlevel"
minInclusive 
(
RminInclusive"
maxInclusive 
(
RmaxInclusive"
minExclusive 
(
RminExclusive"
maxExclusive 
(
RmaxExclusive"b
EnumerationAlarm8
level
 
(2".yamcs.protobuf.mdb.AlarmLevelTypeRlevel
label 
(	Rlabel"?
	AlarmInfo$

minViolations
 
(R
minViolationsN
staticAlarmRange (2.yamcs.protobuf.mdb.AlarmRangeB
RstaticAlarmRangeL
staticAlarmRanges (2.yamcs.protobuf.mdb.AlarmRangeRstaticAlarmRangesT
enumerationAlarm (2$.yamcs.protobuf.mdb.EnumerationAlarmB
RenumerationAlarmR
enumerationAlarms (2$.yamcs.protobuf.mdb.EnumerationAlarmRenumerationAlarmsF
defaultLevel 
(2".yamcs.protobuf.mdb.AlarmLevelTypeRdefaultLevel"?

ContextAlarmInfoB

comparison
 (2".yamcs.protobuf.mdb.ComparisonInfoR
comparison3
alarm 
(2.yamcs.protobuf.mdb.AlarmInfoRalarm
context 
(	Rcontext"?
DataEncodingInfo=
type
 
(2).yamcs.protobuf.mdb.DataEncodingInfo.TypeRtype"
littleEndian 
(RlittleEndian

sizeInBits 
(R
sizeInBits
encoding 
(	RencodingP
defaultCalibrator 
(2".yamcs.protobuf.mdb.CalibratorInfoRdefaultCalibrator[
contextCalibrator (2).yamcs.protobuf.mdb.ContextCalibratorInfoB
RcontextCalibratorY
contextCalibrators (2).yamcs.protobuf.mdb.ContextCalibratorInfoRcontextCalibrators"C
Type

BINARY
BOOLEAN
	
FLOAT
INTEGER

STRING"?

ContextCalibratorInfoB

comparison
 (2".yamcs.protobuf.mdb.ComparisonInfoR
comparisonB

calibrator 
(2".yamcs.protobuf.mdb.CalibratorInfoR
calibrator
context 
(	Rcontext"?
CalibratorInfo`
polynomialCalibrator 
(2,.yamcs.protobuf.mdb.PolynomialCalibratorInfoRpolynomialCalibratorT
splineCalibrator 
(2(.yamcs.protobuf.mdb.SplineCalibratorInfoRsplineCalibratorl
javaExpressionCalibrator 
(20.yamcs.protobuf.mdb.JavaExpressionCalibratorInfoRjavaExpressionCalibrator;
type 
(2'.yamcs.protobuf.mdb.CalibratorInfo.TypeRtype"K
Type

POLYNOMIAL

SPLINE

MATH_OPERATION
JAVA_EXPRESSION"d
PolynomialCalibratorInfo$
coefficient
 (
B
Rcoefficient"
coefficients (
Rcoefficients"?
SplineCalibratorInfoR
point
 (28.yamcs.protobuf.mdb.SplineCalibratorInfo.SplinePointInfoB
RpointP
points (28.yamcs.protobuf.mdb.SplineCalibratorInfo.SplinePointInfoRpointsC
SplinePointInfo
raw
 
(
Rraw

calibrated 
(
R
calibrated"8
JavaExpressionCalibratorInfo
formula
 
(	Rformula"Y
	EnumValue
value
 
(Rvalue
label 
(	Rlabel 
description 
(	Rdescription"?	
ParameterTypeInfo
name 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias
engType
 
(	RengTypeH
dataEncoding 
(2$.yamcs.protobuf.mdb.DataEncodingInfoRdataEncoding6
unitSet (2.yamcs.protobuf.mdb.UnitInfoRunitSetA
defaultAlarm 
(2.yamcs.protobuf.mdb.AlarmInfoRdefaultAlarm;
	enumValue (2.yamcs.protobuf.mdb.EnumValueR	enumValueP
absoluteTimeInfo 
(2$.yamcs.protobuf.mdb.AbsoluteTimeInfoRabsoluteTimeInfoH
contextAlarm (2$.yamcs.protobuf.mdb.ContextAlarmInfoRcontextAlarm6
member (2.yamcs.protobuf.mdb.MemberInfoRmember;
	arrayInfo	 
(2.yamcs.protobuf.mdb.ArrayInfoR	arrayInfo^

ancillaryData
 (28.yamcs.protobuf.mdb.ParameterTypeInfo.AncillaryDataEntryR
ancillaryDataL
numberFormat 
(2(.yamcs.protobuf.mdb.NumberFormatTypeInfoRnumberFormat
signed 
(Rsigned

sizeInBits 
(R
sizeInBits(
zeroStringValue
 
(	RzeroStringValue&
oneStringValue 
(	RoneStringValue9
usedBy (2!.yamcs.protobuf.mdb.ParameterInfoRusedByg
AncillaryDataEntry
key
 
(	Rkey;
value 
(2%.yamcs.protobuf.mdb.AncillaryDataInfoRvalue:8
"?
NumberFormatTypeInfo

numberBase
 
(	R
numberBase4
minimumFractionDigits 
(RminimumFractionDigits4
maximumFractionDigits 
(RmaximumFractionDigits2
minimumIntegerDigits 
(RminimumIntegerDigits2
maximumIntegerDigits 
(RmaximumIntegerDigits&
negativeSuffix 
(	RnegativeSuffix&
positiveSuffix 
(	RpositiveSuffix&
negativePrefix 
(	RnegativePrefix&
positivePrefix	 
(	RpositivePrefix4
showThousandsGrouping
 
(RshowThousandsGrouping
notation 
(	Rnotation"E
GetContainerRequest
instance
 
(	Rinstance
name 
(	Rname"I
GetParameterTypeRequest
instance
 
(	Rinstance
name 
(	Rname"?

AbsoluteTimeInfo"
initialValue
 
(	RinitialValue
scale 
(
Rscale
offset 
(
RoffsetA

offsetFrom 
(2!.yamcs.protobuf.mdb.ParameterInfoR
offsetFrom
epoch 
(	Repoch"?


MemberInfo
name
 
(	Rname*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias9
type 
(2%.yamcs.protobuf.mdb.ParameterTypeInfoRtype"?
ArgumentMemberInfo
name
 
(	Rname*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias8
type 
(2$.yamcs.protobuf.mdb.ArgumentTypeInfoRtype"
initialValue 
(	RinitialValue"?

ParameterDimensionInfo

fixedValue
 
(R
fixedValue?
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter
slope 
(Rslope
	intercept 
(R	intercept"?

	ArrayInfo9
type
 
(2%.yamcs.protobuf.mdb.ParameterTypeInfoRtypeJ

dimensions (2*.yamcs.protobuf.mdb.ParameterDimensionInfoR
dimensions"?


UsedByInfo?
	algorithm
 (2!.yamcs.protobuf.mdb.AlgorithmInfoR	algorithm?
	container (2!.yamcs.protobuf.mdb.ContainerInfoR	container"?

ParameterInfo
name
 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias9
type 
(2%.yamcs.protobuf.mdb.ParameterTypeInfoRtypeB

dataSource 
(2".yamcs.protobuf.mdb.DataSourceTypeR
dataSource6
usedBy 
(2.yamcs.protobuf.mdb.UsedByInfoRusedByZ

ancillaryData	 (24.yamcs.protobuf.mdb.ParameterInfo.AncillaryDataEntryR
ancillaryData
path
 (	Rpathg
AncillaryDataEntry
key
 
(	Rkey;
value 
(2%.yamcs.protobuf.mdb.AncillaryDataInfoRvalue:8
"Y
AncillaryDataInfo
value
 
(	Rvalue
mimeType 
(	RmimeType
href 
(	Rhref"?
ArgumentTypeInfo
engType
 
(	RengTypeH
dataEncoding 
(2$.yamcs.protobuf.mdb.DataEncodingInfoRdataEncoding6
unitSet (2.yamcs.protobuf.mdb.UnitInfoRunitSet;
	enumValue (2.yamcs.protobuf.mdb.EnumValueR	enumValue
rangeMin 
(
RrangeMin
rangeMax 
(
RrangeMax>
member (2&.yamcs.protobuf.mdb.ArgumentMemberInfoRmember(
zeroStringValue	 
(	RzeroStringValue&
oneStringValue
 
(	RoneStringValue
minChars 
(RminChars
maxChars 
(RmaxChars
signed
 
(Rsigned
minBytes 
(RminBytes
maxBytes 
(RmaxBytesI

dimensions (2).yamcs.protobuf.mdb.ArgumentDimensionInfoR
dimensionsF
elementType 
(2$.yamcs.protobuf.mdb.ArgumentTypeInfoRelementType
name 
(	Rname"?

ArgumentDimensionInfo

fixedValue
 
(R
fixedValue?
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter
argument 
(	Rargument
slope 
(Rslope
	intercept 
(R	intercept"?

ArgumentInfo
name
 
(	Rname 
description 
(	Rdescription"
initialValue 
(	RinitialValue8
type 
(2$.yamcs.protobuf.mdb.ArgumentTypeInfoRtype"B
ArgumentAssignmentInfo
name
 
(	Rname
value 
(	Rvalue"?
SignificanceInfof
consequenceLevel
 
(2:.yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelTypeRconsequenceLevel*
reasonForWarning 
(	RreasonForWarning"a
SignificanceLevelType
NONE
	
WATCH
WARNING
DISTRESS
CRITICAL

SEVERE"?
ComparisonInfo?
	parameter
 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameterK
operator 
(2/.yamcs.protobuf.mdb.ComparisonInfo.OperatorTypeRoperator
value 
(	Rvalue<
argument 
(2 .yamcs.protobuf.mdb.ArgumentInfoRargument"?

OperatorType
EQUAL_TO

NOT_EQUAL_TO
GREATER_THAN
GREATER_THAN_OR_EQUAL_TO
SMALLER_THAN
SMALLER_THAN_OR_EQUAL_TO"V
TransmissionConstraintInfo

expression 
(	R
expression
timeout 
(Rtimeout"?
CommandInfo
name
 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRaliasA
baseCommand 
(2.yamcs.protobuf.mdb.CommandInfoRbaseCommand
abstract 
(Rabstract<
argument (2 .yamcs.protobuf.mdb.ArgumentInfoRargumentZ
argumentAssignment	 (2*.yamcs.protobuf.mdb.ArgumentAssignmentInfoRargumentAssignmentH
significance
 
(2$.yamcs.protobuf.mdb.SignificanceInfoRsignificanceN

constraint (2..yamcs.protobuf.mdb.TransmissionConstraintInfoR
constraintT
commandContainer
 
(2(.yamcs.protobuf.mdb.CommandContainerInfoRcommandContainer<
verifier (2 .yamcs.protobuf.mdb.VerifierInfoRverifierX

ancillaryData (22.yamcs.protobuf.mdb.CommandInfo.AncillaryDataEntryR
ancillaryDataZ
effectiveSignificance 
(2$.yamcs.protobuf.mdb.SignificanceInfoReffectiveSignificanceg
AncillaryDataEntry
key
 
(	Rkey;
value 
(2%.yamcs.protobuf.mdb.AncillaryDataInfoRvalue:8
"?
VerifierInfo
stage
 
(	Rstage?
	container 
(2!.yamcs.protobuf.mdb.ContainerInfoR	container?
	algorithm 
(2!.yamcs.protobuf.mdb.AlgorithmInfoR	algorithmT
	onSuccess 
(26.yamcs.protobuf.mdb.VerifierInfo.TerminationActionTypeR	onSuccessN
onFail 
(26.yamcs.protobuf.mdb.VerifierInfo.TerminationActionTypeRonFailT
	onTimeout 
(26.yamcs.protobuf.mdb.VerifierInfo.TerminationActionTypeR	onTimeoutE
checkWindow 
(2#.yamcs.protobuf.mdb.CheckWindowInfoRcheckWindow

expression 
(	R
expression".
TerminationActionType
SUCCESS

FAIL"?

CheckWindowInfo0
timeToStartChecking
 
(RtimeToStartChecking.
timeToStopChecking 
(RtimeToStopChecking

relativeTo 
(	R
relativeTo"?


RepeatInfo

fixedCount
 
(R
fixedCountE
dynamicCount 
(2!.yamcs.protobuf.mdb.ParameterInfoRdynamicCount 
bitsBetween 
(RbitsBetween"?
SequenceEntryInfo&
locationInBits
 
(RlocationInBitsi
referenceLocation 
(2;.yamcs.protobuf.mdb.SequenceEntryInfo.ReferenceLocationTypeRreferenceLocation?
	container 
(2!.yamcs.protobuf.mdb.ContainerInfoR	container?
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter<
argument 
(2 .yamcs.protobuf.mdb.ArgumentInfoRargumentB

fixedValue 
(2".yamcs.protobuf.mdb.FixedValueInfoR
fixedValue6
repeat 
(2.yamcs.protobuf.mdb.RepeatInfoRrepeat`
indirectParameterRef 
(2,.yamcs.protobuf.mdb.IndirectParameterRefInfoRindirectParameterRef"@
ReferenceLocationType
CONTAINER_START

PREVIOUS_ENTRY"`
FixedValueInfo
name
 
(	Rname
hexValue 
(	RhexValue

sizeInBits 
(R
sizeInBits"?
CommandContainerInfo
name
 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias

sizeInBits 
(R
sizeInBitsN

baseContainer 
(2(.yamcs.protobuf.mdb.CommandContainerInfoR
baseContainer;
entry (2%.yamcs.protobuf.mdb.SequenceEntryInfoRentry"?

IndirectParameterRefInfo?
	parameter
 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter&
aliasNamespace 
(	RaliasNamespace"?

ContainerInfo
name
 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias 
maxInterval 
(RmaxInterval

sizeInBits 
(R
sizeInBitsG

baseContainer 
(2!.yamcs.protobuf.mdb.ContainerInfoR
baseContainerX
restrictionCriteria	 (2".yamcs.protobuf.mdb.ComparisonInfoB
RrestrictionCriteriaD
restrictionCriteriaExpression
 
(	RrestrictionCriteriaExpression;
entry
 (2%.yamcs.protobuf.mdb.SequenceEntryInfoRentry6
usedBy 
(2.yamcs.protobuf.mdb.UsedByInfoRusedByZ

ancillaryData (24.yamcs.protobuf.mdb.ContainerInfo.AncillaryDataEntryR
ancillaryData*
archivePartition 
(RarchivePartitiong
AncillaryDataEntry
key
 
(	Rkey;
value 
(2%.yamcs.protobuf.mdb.AncillaryDataInfoRvalue:8
"?

InputParameterInfo?
	parameter
 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter
	inputName 
(	R	inputName,
parameterInstance 
(RparameterInstance
	mandatory 
(R	mandatory<
argument 
(2 .yamcs.protobuf.mdb.ArgumentInfoRargument"v
OutputParameterInfo?
	parameter
 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter

outputName 
(	R
outputName"?
MathElement8
type
 
(2$.yamcs.protobuf.mdb.MathElement.TypeRtype
operator 
(	Roperator
value 
(
Rvalue?
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter,
parameterInstance 
(RparameterInstance"R
Type

VALUE_OPERAND

THIS_PARAMETER_OPERAND
OPERATOR
	PARAMETER"?

AlgorithmInfo
name
 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias=
scope 
(2'.yamcs.protobuf.mdb.AlgorithmInfo.ScopeRscope:
type
 
(2&.yamcs.protobuf.mdb.AlgorithmInfo.TypeRtype
language 
(	Rlanguage
text 
(	RtextN
inputParameter	 (2&.yamcs.protobuf.mdb.InputParameterInfoRinputParameterQ
outputParameter
 (2'.yamcs.protobuf.mdb.OutputParameterInfoRoutputParameterO
onParameterUpdate (2!.yamcs.protobuf.mdb.ParameterInfoRonParameterUpdate&
onPeriodicRate (RonPeriodicRateC
mathElements (2.yamcs.protobuf.mdb.MathElementRmathElements"
Type

CUSTOM

MATH"G
Scope

GLOBAL
COMMAND_VERIFICATION

CONTAINER_PROCESSING"
ListSpaceSystemsRequest
instance
 
(	Rinstance

q 
(	R
q
next 
(	Rnext
pos 
(Rpos
limit	 
(Rlimit"?

ListContainersRequest
instance
 
(	Rinstance

q 
(	R
q
system
 
(	Rsystem
next 
(	Rnext
pos 
(Rpos
limit	 
(Rlimit"?

ListParameterTypesRequest
instance
 
(	Rinstance

q 
(	R
q
system
 
(	Rsystem
next 
(	Rnext
pos 
(Rpos
limit	 
(Rlimit"?

ListAlgorithmsRequest
instance
 
(	Rinstance

q 
(	R
q
system
 
(	Rsystem
next 
(	Rnext
pos 
(Rpos
limit	 
(Rlimit=
scope 
(2'.yamcs.protobuf.mdb.AlgorithmInfo.ScopeRscope"?

ListCommandsRequest
instance
 
(	Rinstance

q 
(	R
q
system 
(	Rsystem
details 
(Rdetails
next 
(	Rnext
pos 
(Rpos
limit	 
(Rlimit

noAbstract
 
(R
noAbstract"E
GetParameterRequest
instance
 
(	Rinstance
name 
(	Rname"?
ListParametersRequest
instance
 
(	Rinstance

q 
(	R
q$

searchMembers 
(R
searchMembers
details 
(Rdetails
type (	Rtype:
source
 
(2".yamcs.protobuf.mdb.DataSourceTypeRsource
system 
(	Rsystem
next 
(	Rnext
pos 
(Rpos
limit	 
(Rlimit"?
ListParametersResponse=
systems (2#.yamcs.protobuf.mdb.SpaceSystemInfoRsystems&
spaceSystems (	B
RspaceSystemsA

parameters
 (2!.yamcs.protobuf.mdb.ParameterInfoR
parameters,
continuationToken 
(	RcontinuationToken
	totalSize 
(R	totalSize"f
BatchGetParametersRequest
instance 
(	Rinstance-
id
 (2.yamcs.protobuf.NamedObjectIdRid"?
BatchGetParametersResponse_
response
 (2C.yamcs.protobuf.mdb.BatchGetParametersResponse.GetParameterResponseRresponse?

GetParameterResponse-
id
 
(2.yamcs.protobuf.NamedObjectIdRid?
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter"?
ListContainersResponse=
systems (2#.yamcs.protobuf.mdb.SpaceSystemInfoRsystems&
spaceSystems (	B
RspaceSystemsA

containers
 (2!.yamcs.protobuf.mdb.ContainerInfoR
containers,
continuationToken 
(	RcontinuationToken
	totalSize 
(R	totalSize"?
ListParameterTypesResponse=
systems (2#.yamcs.protobuf.mdb.SpaceSystemInfoRsystems&
spaceSystems (	B
RspaceSystemsM
parameterTypes
 (2%.yamcs.protobuf.mdb.ParameterTypeInfoRparameterTypes,
continuationToken 
(	RcontinuationToken
	totalSize 
(R	totalSize"?
ListCommandsResponse=
systems (2#.yamcs.protobuf.mdb.SpaceSystemInfoRsystems&
spaceSystems (	B
RspaceSystems;
commands
 (2.yamcs.protobuf.mdb.CommandInfoRcommands,
continuationToken 
(	RcontinuationToken
	totalSize 
(R	totalSize"?
ListAlgorithmsResponse=
systems (2#.yamcs.protobuf.mdb.SpaceSystemInfoRsystems&
spaceSystems (	B
RspaceSystemsA

algorithms
 (2!.yamcs.protobuf.mdb.AlgorithmInfoR
algorithms,
continuationToken 
(	RcontinuationToken
	totalSize 
(R	totalSize"E
GetAlgorithmRequest
instance
 
(	Rinstance
name 
(	Rname"?
CreateParameterRequest
instance
 
(	Rinstance
name 
(	Rname*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescriptionQ
aliases (27.yamcs.protobuf.mdb.CreateParameterRequest.AliasesEntryRaliasesB

dataSource 
(2".yamcs.protobuf.mdb.DataSourceTypeR
dataSource$

parameterType 
(	R
parameterType:
AliasesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?
CreateParameterTypeRequest
instance
 
(	Rinstance
name 
(	Rname*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescriptionU
aliases (2;.yamcs.protobuf.mdb.CreateParameterTypeRequest.AliasesEntryRaliases
engType 
(	RengType
unit 
(	Runit
signed 
(RsignedA
defaultAlarm	 
(2.yamcs.protobuf.mdb.AlarmInfoRdefaultAlarmJ

contextAlarms
 (2$.yamcs.protobuf.mdb.ContextAlarmInfoR
contextAlarmsK
enumerationValues (2.yamcs.protobuf.mdb.EnumValueRenumerationValues(
zeroStringValue 
(	RzeroStringValue&
oneStringValue
 
(	RoneStringValue:
AliasesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"7
GetMissionDatabaseRequest
instance
 
(	Rinstance">
 ExportJavaMissionDatabaseRequest
instance
 
(	Rinstance"?
StreamMissionDatabaseRequest
instance
 
(	Rinstance0
includeSpaceSystems 
(RincludeSpaceSystems,
includeContainers 
(RincludeContainers,
includeParameters 
(RincludeParameters4
includeParameterTypes 
(RincludeParameterTypes(
includeCommands 
(RincludeCommands,
includeAlgorithms 
(RincludeAlgorithms"?
MissionDatabaseItemG
spaceSystem
 
(2#.yamcs.protobuf.mdb.SpaceSystemInfoHRspaceSystemA
	container 
(2!.yamcs.protobuf.mdb.ContainerInfoHR	containerA
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoHR	parameterM

parameterType 
(2%.yamcs.protobuf.mdb.ParameterTypeInfoHR
parameterType;
command 
(2.yamcs.protobuf.mdb.CommandInfoHRcommandA
	algorithm 
(2!.yamcs.protobuf.mdb.AlgorithmInfoHR	algorithmB
item"?

ListSpaceSystemsResponseG
spaceSystems
 (2#.yamcs.protobuf.mdb.SpaceSystemInfoRspaceSystems,
continuationToken 
(	RcontinuationToken
	totalSize 
(R	totalSize"G
GetSpaceSystemRequest
instance
 
(	Rinstance
name 
(	Rname"C
ExportXtceRequest
instance
 
(	Rinstance
name 
(	Rname"C
GetCommandRequest
instance
 
(	Rinstance
name 
(	Rname"?
SpaceSystemInfo
name
 
(	Rname$

qualifiedName 
(	R
qualifiedName*
shortDescription 
(	RshortDescription(
longDescription 
(	RlongDescription3
alias (2.yamcs.protobuf.NamedObjectIdRalias
version 
(	Rversion9
history (2.yamcs.protobuf.mdb.HistoryInfoRhistory5
sub (2#.yamcs.protobuf.mdb.SpaceSystemInfoRsub\

ancillaryData (26.yamcs.protobuf.mdb.SpaceSystemInfo.AncillaryDataEntryR
ancillaryDatag
AncillaryDataEntry
key
 
(	Rkey;
value 
(2%.yamcs.protobuf.mdb.AncillaryDataInfoRvalue:8
*?

DataSourceType
TELEMETERED
DERIVED

CONSTANT	
LOCAL

SYSTEM
COMMAND
COMMAND_HISTORY
	EXTERNAL1
	EXTERNAL2
	EXTERNAL3	

GROUND
*\
AlarmLevelType

NORMAL	
WATCH

WARNING
DISTRESS
CRITICAL

SEVERE2?
MdbApi?

GetMissionDatabase-.yamcs.protobuf.mdb.GetMissionDatabaseRequest#.yamcs.protobuf.mdb.MissionDatabase"??
/api/mdb/{instance}?

ExportJavaMissionDatabase4.yamcs.protobuf.mdb.ExportJavaMissionDatabaseRequest.yamcs.api.HttpBody"$?? 
/api/mdb/{instance}:exportJava?

ListSpaceSystems+.yamcs.protobuf.mdb.ListSpaceSystemsRequest,.yamcs.protobuf.mdb.ListSpaceSystemsResponse"5??1
!/api/mdb/{instance}/space-systemsRspaceSystems?

GetSpaceSystem).yamcs.protobuf.mdb.GetSpaceSystemRequest#.yamcs.protobuf.mdb.SpaceSystemInfo"/??+
)/api/mdb/{instance}/space-systems/{name*}?


ExportXtce%.yamcs.protobuf.mdb.ExportXtceRequest.yamcs.api.HttpBody"G??C
4/api/mdb/{instance}/space-systems/{name*}:exportXTCEjExport XTCE?

StreamMissionDatabase0.yamcs.protobuf.mdb.StreamMissionDatabaseRequest'.yamcs.protobuf.mdb.MissionDatabaseItem"1??-
)/api/mdb/{instance}:streamMissionDatabaseH
0
?

ListParameters).yamcs.protobuf.mdb.ListParametersRequest*.yamcs.protobuf.mdb.ListParametersResponse"0??,
/api/mdb/{instance}/parametersR
parameters?

GetParameter'.yamcs.protobuf.mdb.GetParameterRequest!.yamcs.protobuf.mdb.ParameterInfo",??(
&/api/mdb/{instance}/parameters/{name*}?

CreateParameter*.yamcs.protobuf.mdb.CreateParameterRequest!.yamcs.protobuf.mdb.ParameterInfo"'??#/api/mdb/{instance}/parameters:
*?

BatchGetParameters-.yamcs.protobuf.mdb.BatchGetParametersRequest..yamcs.protobuf.mdb.BatchGetParametersResponse"0??,'/api/mdb/{instance}/parameters:batchGet:
*?

ListParameterTypes-.yamcs.protobuf.mdb.ListParameterTypesRequest..yamcs.protobuf.mdb.ListParameterTypesResponse"9??5
#/api/mdb/{instance}/parameter-typesRparameterTypes?

GetParameterType+.yamcs.protobuf.mdb.GetParameterTypeRequest%.yamcs.protobuf.mdb.ParameterTypeInfo"1??-
+/api/mdb/{instance}/parameter-types/{name*}?

CreateParameterType..yamcs.protobuf.mdb.CreateParameterTypeRequest%.yamcs.protobuf.mdb.ParameterTypeInfo",??(#/api/mdb/{instance}/parameter-types:
*?

ListContainers).yamcs.protobuf.mdb.ListContainersRequest*.yamcs.protobuf.mdb.ListContainersResponse"0??,
/api/mdb/{instance}/containersR
containers?

GetContainer'.yamcs.protobuf.mdb.GetContainerRequest!.yamcs.protobuf.mdb.ContainerInfo",??(
&/api/mdb/{instance}/containers/{name*}?

ListCommands'.yamcs.protobuf.mdb.ListCommandsRequest(.yamcs.protobuf.mdb.ListCommandsResponse",??(
/api/mdb/{instance}/commandsRcommands?


GetCommand%.yamcs.protobuf.mdb.GetCommandRequest.yamcs.protobuf.mdb.CommandInfo"*??&
$/api/mdb/{instance}/commands/{name*}?

ListAlgorithms).yamcs.protobuf.mdb.ListAlgorithmsRequest*.yamcs.protobuf.mdb.ListAlgorithmsResponse"0??,
/api/mdb/{instance}/algorithmsR
algorithms?

GetAlgorithm'.yamcs.protobuf.mdb.GetAlgorithmRequest!.yamcs.protobuf.mdb.AlgorithmInfo",??(
&/api/mdb/{instance}/algorithms/{name*}??
MDBB
org.yamcs.protobufJՆ
?










+
	

+
	
%
	

"
	
$

	?





	



#

?
#
&

 Get a mission database







2


=L



?2
E

7 Export a java serialized dump of the mission database







 @


K]





?2
"
  List space systems





.

9Q



?2
"
#' Get a space system



#

#*

#5D

$&

?2$&
?
/4? Export an XTCE representation of a space system.

 If the requested space system is not the root, containers will have
 their qualified name stripped by the top name. In addition there may
 also be references to objects from space systems that are not part of
 the export.



/

/"

/-?

03

?203
?

;@?
 Stream Mission Database items.

 This operation is intended for tools that need to efficiently fetch
 the full list of parameters or commands, without using repeated
 pagination-based requests.



;

;8

;CI

;J]

<?

?2<?

CH List parameters



C

C*

C5K

DG

?2DG

KO Get a parameter



K

K&

K1>

LN

?2LN
"
RW Create a parameter



R

R,

R7D

SV

?2SV
0
	Z_" Batch get of multiple parameters


	
Z

	Z2

	Z=W

	[^

	?2[^
$

bg List parameter types




b


b2


b=W


cf


?2cf
$
jn Get a parameter type



j

j.

j9J

km

?2km
'
qv Create a parameter type



q

q4

q?P

ru

?2ru


y~ List containers




y


y*


y5K


z}


?2z}
!
?
?
 Get a container



?


?
&

?
1>

?
?


?2?
?


?
?
 List commands



?


?
&

?
1E

?
?


?2?
?


?
?
 Get a command



?


?
"

?
-8

?
?


?2?
?

!
?
?
 List algorithms



?


?
*

?
5K

?
?


?2?
?

"
?
?
 Get an algorithm



?


?
&

?
1>

?
?


?2?
?


?
?




?

6
?
!( This is the config section in mdb.yaml


?



?



?


?
 
&

?
 Root space-system name



?




?




?



?

0
?
" Root space-system header version


?



?



?


?

8
?
=* Deprecated, use ``spaceSystems`` instead


?



?



?
&

?
)*

?
+<

?
,;

?
-

?



?



?
'

?
*,

?
$

?



?



?


?
"#

?
$

?



?



?


?
"#

?
"

?



?



?


?
 !

?
$

?



?



?


?
"#

	?
)

	?



	?


	
?
#

	?
&(


?
?





?



?



?




?




?



?




?




?





?





?




?



?



?




?




?



?



?



?




?




?



?


?
?




?


?



?


?



?




?
	


?


?



?



?



?



?


?



?



?


?


?



?
	

?


?



?


?


?



?


?


?



?


?


	?


	
?


	?



?




?



?



?
?





?



?




?



?




?





?




?




?




?
	


?




?




?




?




?




?




?




?




?



?


?
?




?


?


?



?



?


?


?
?




?


?
$

?



?



?


?
"#


?
#


?




?




?



?
!"

?
#

?



?



?


?
!"

?
#

?



?



?


?
!"

?
#

?



?



?


?
!"

?
?




?


?
$

?



?



?


?
"#


?



?




?




?



?


?
?




?


?
#

?



?



?


?
!"
=

?
=/ Deprecated, use ``staticAlarmRanges`` instead



?




?




?
&


?
)*


?
+<


?
,;

?
,

?



?



?
'

?
*+
=
?
C/ Deprecated, use ``enumerationAlarms`` instead


?



?



?
,

?
/0

?
1B

?
2A

?
2

?



?



?
-

?
01
?
?
+? only used for enumeration alarms - defines the alarm state if none of the condition above applies
 as per XTCE description:
   defaults to "normal", which is almost always the case.
   Setting it to another alarm state permits a form of "inverted logic" where the alarm list can specify the normal states instead of the alarm states.


?



?



?
&

?
)*

?
?



?


?
)

?



?



?
$

?
'(


?



?




?




?



?

?

??
 This can be used in UpdateParameterRequest to pass a context
 that is parsed on the server, according to the rules in the
 excel spreadsheet. Either this or a comparison has to be
 used (not both at the same time)


?


?


?

?

??



?

??


?

?


?


?



?



?


?

?


?	

?

?


?

?

?


?


?


?

?


?


?

?


?!


?



?



?


? 

? 

?


?


?

?

?

?


?


?

?

?0

?


?


?+

?./
>
?I0 Deprecated, use ``contextCalibrators`` instead


?


? 


?!2

?56

?7H

?8G

?8

?


? 


?!3

?67

??



?

?)

?


?


?$

?'(


?)


?



?



?$


?'(
?

??
 This can be used in UpdateParameterRequest to pass a context
 that is parsed on the server, according to the rules in the
 excel spreadsheet. Either this or a comparison has to be
 used (not both at the same time)


?


?


?

?

	??


	
?

	??

	
?

	?

	
?

	?

	
?

	

?

	
?

	?

	
?

	?

	?

	
?

	?

	?=

	?


	?#

	
?$8

	?;<

	
?5

	
?


	
?

	

? 0

	
?34

	?E

	?


	?'

	
?(@

	?CD

	?

	?


	?

	
?

	?


??




? 
8

?4* Deprecated, use ``coefficients`` instead



?



?



?


? !


?"3


?#2



?#



?




?




?



?!"

??



?

??


?


?

?

?



?

?


?#


?


?




?


?!"
2
?7$ Deprecated, use ``points`` instead


?


?


? 

?#$

?%6

?&5


?&


?



?



?!


?$%

??



?$

?

?


?


?

?


??




?


?


?



?



?


?



?



?




?




?



?


?"


?



?



?


? !

??



?

?

?


?


?

?


?%


?



?



?


?"$

?(

?


?


?"

?%'

?'

?


?


?!

?$&

?$

?


?


?

?!#
 
? Engineering type


?


?


?

?

?-

?


?


?(

?+,

? 

?


?


?

?
S
?&E Default Alarm, effective when no contextual alarm takes precedence.


?


?


?!

?$%

	?#

	?


	?

	
?

	?!"


?1


?



?



?,


?/0
!
?- Contextual alarms


?


?


?(

?+,

?!

?


?


?

? 


?#


?



?



?


?!"

?4

? 


?!.

?13
S
?2E Provides hints on how to format the engineering
 value as a string.


?


?


? ,

?/1
t
?f True if the engineering type supports signed representation.
 (only used by integer parameter types)


?


?


?

?
B
?!4 Hint about the range of allowed engineering values


?


?


?

? 
T
?'F String representation of a boolean zero (only used by boolean types)


?


?


?!

?$&
S
?&E String representation of a boolean one (only used by boolean types)


?


?


? 

?#%
?

?%x Which parameters this type is used by. This field is only
 populated when requesting directly a single parameter type.


?


?


?

?"$

??



?

?!

?


?


?

? 


?+


?



?



?&


?)*

?+

?


?


?&

?)*

?*

?


?


?%

?()

?*

?


?


?%

?()

?%

?


?


? 

?#$

?%

?


?


? 

?#$

?%

?


?


? 

?#$

?%

?


?


? 

?#$

	?+

	?


	?

	
?%

	?(*


? 


?



?



?


?

??



?
$
? Yamcs instance name.


?


?


?

?


? Container name.



?



?



?


?

??



?
$
? Yamcs instance name.


?


?


?

?
$

? Parameter type name.



?



?



?


?

??



?

?#

?


?


?

?!"


?


?



?



?


?

?

?


?


?

?

?(

?


?


?#

?&'

?

?


?


?

?

??



?

?

?


?


?

?


?'


?



?



?"


?%&

?&

?


?


?!

?$%

?#

?


?


?

?!"

?&

?


?


?!

?$%

??



?

?

?


?


?

?


?'


?



?



?"


?%&

?&

?


?


?!

?$%

?#

?


?


?

?!"

?%

?


?


? 

?#$

?#

?


?


?

?!"

??



?

? 

?


?


?

?


?'


?



?



?"


?%&

?

?


?


?

?

?

?


?


?

?

??



?

?&

?


?


?!

?$%


?1


?



?!



?",


?/0

??



?

?'

?


?


?"

?%&


?'


?



?



?"


?%&

??



?

?

?


?


?

?


?$


?



?



?


?"#

?'

?


?


?"

?%&

?&

?


?


?!

?$%

?#

?


?


?

?!"

?&

?


?


?!

?$%

?)

?


?


?$

?'(

?!

?


?


?

? 

?3

? 


?!.

?12
?

	?} Operations that return aggregate members or array entries
 may use this field to indicate the path within the parameter.   


	?


	?

	
?

	?

??



?

?

?


?


?

?


?


?



?



?


?

?

?


?


?

?

??



?

?

?


?


?

?


?-


?



?



?(


?+,

? 

?


?


?

?
F
?#8 Enumeration states (only used by enumerated arguments)


?


?


?

?!"
H
?: Minimum value (only used by integer and float arguments)


?


?


?

?
H
?: Maximum value (only used by integer and float arguments)


?


?


?

?
E
?)7 Member information (only used by aggregate arguments)


?


?


?$

?'(
X
?&J String representation of a boolean zero (only used by boolean arguments)


?


?


?!

?$%
W
?&I String representation of a boolean one (only used by boolean arguments)


?


?


? 

?#%
G
	?9 Minimum character count (only used by string arguments)


	?


	?

	
?

	?
G

?9 Maximum character count (only used by string arguments)



?



?



?


?
n
?` True if the engineering type supports signed representation.
 (only used by integer arguments)


?


?


?

?
B
?4 Minimum byte count (only used by binary arguments)


?


?


?

?
G

?9 Maximum character count (only used by binary arguments)



?



?



?


?
G
?19 Length of each dimension (only used by array arguments)


?


? 


?!+

?.0
D
?-6 Type of array entries (only used by array arguments)


?


?


?'

?*,
*
? Name of the parameter type


?


?


?

?

??



?
u
? g Use a fixed integer value. If set, no other options are applicable.
 This value describes the length.


?


?


?

?
?


?'?
 Use the value of the referenced parameter.
 The value describes the zero-based ending index (length - 1)

 For a value ``v``, the dimension's length is determined
 as: ``(v * slope) + intercept``. 



?



?



?"


?%&
?

??
 Use the value of the referenced argument.
 The value describes the zero-based ending index (length - 1)

 For a value ``v``, the dimension's length is determined
 as: ``(v * slope) + intercept``.


?


?


?

?
P
?B Scale the value obtained from a parameter or argument reference.


?


?


?

?
P
?B Shift the value obtained from a parameter or argument reference.


?


?


?

?

??



?

?

?


?


?

?


?"


?



?



?


? !

?#

?


?


?

?!"

?%

?


?


? 

?#$

??



?

?

?


?


?

?


?


?



?



?


?

??



?

??


?

?


?

?


?



?	


?

?


?

?

?


?

?

?


?

?

?


?


?


?6

?


? 


?!1

?45


?'


?



?



?"


?%&

??



?

??


?

?


?

?


?



?


?

?


?

?

?!


?

? 

?


?

?

?!


?

? 

?'

?


?


?"

?%&


?%


?



?



? 


?#$

?

?


?


?

?

?%

?


?


? 

?#$

 ??


 
?"

 ?!

 ?


 ?

 
?

 ? 

 
?

 
?


 
?

 

?

 
?

!??


!
?

!?

!?


!?

!
?

!?

!
?$

!
?


!
?

!

?

!
?"#

!?'

!?


!?

!
?"

!?%&

!?&

!?


!?

!
?!

!?$%

!?#

!?


!?

!
?

!?!"

!?'

!?


!?

!
?"

!?%&

!?

!?


!?

!
?

!?

!?%

!?


!?

!
? 

!?#$

!?9

!?


!?!

!
?"4

!?78
?

!	?.?
 Command significance.

 This is the significance defined specifically for this command.
 If unset, there may still be a significance inherited from
 a base command.


!	?


!	?

!	
?(

!	?+-

!
?6

!
?


!
?%

!

?&0

!
?35

!?6

!?


!?

!
? 0

!?35

!?&

!?


!?

!
? 

!?#%

!
?4

!
? 

!

?!.

!
?13
?

!?7?
 Effective command significance.

 This is the significance obtained by looking up the first defined
 significance either in this command, or the nearest base command.


!?


!?

!
?1

!?46

"??


"
?

"??

"
?

"?

"
?

"?

"
?

"

?

"
?

"?

"?


"?

"
?

"?
0
"
?'" Container update that is checked


"
?


"
?

"

?"

"
?%&

"?'

"?


"?

"
?"

"?%&
9
"?/+ What action to take when a check succeeds


"?


"? 

"
?!*

"?-.
6
"?,( What action to take when a check fails


"?


"? 

"
?!'

"?*+
:
"?/, What action to take when a check times out


"?


"? 

"
?!*

"?-.
<
"?+. Time window during which a check is executed


"?


"?

"
?&

"?)*
6
"?!( Expression used to check this verifier


"?


"?

"
?

"? 

#??


#
?
>
#?)0 Delay in milliseconds before starting to check


#?


#?

#
?$

#?'(
<
#
?(. Duration in milliseconds of the check window


#
?


#
?

#

?#

#
?&'
<
#?!. Reference time for starting the check window


#?


#?

#
?

#? 

$??


$
?

$? 

$?


$?

$
?

$?

$
?*

$
?


$
?

$

?%

$
?()

$?!

$?


$?

$
?

$? 

%??


%
?

%??

%
?

%?

%
?

%?

%
?

%

?

%
?

%?$

%?


%?

%
?

%?"#

%
?7

%
?


%
? 

%

?!2

%
?56
.
%?'  For use in sequence containers


%?


%?

%
?"

%?%&

%?'

%?


%?

%
?"

%?%&
-
%?% For use in command containers


%?


%?

%
? 

%?#$

%?)

%?


%?

%
?$

%?'(

%?!

%?


%?

%
?

%? 

%?=

%?


%?#

%
?$8

%?;<

&??


&
?

&?

&?


&?

&
?

&?

&
?

&
?


&
?

&

?

&
?

&? 

&?


&?

&
?

&?

'??


'
?

'?

'?


'?

'
?

'?

'
?$

'
?


'
?

'

?

'
?"#

'?'

'?


'?

'
?"

'?%&

'?&

'?


'?

'
?!

'?$%

'?#

'?


'?

'
?

'?!"

'? 

'?


'?

'
?

'?

'?2

'?


'?

'
? -

'?01

'?'

'?


'?

'
?"

'?%&

(??


(
? 

(?(

(?

(?

(
?#

(?&'

(
?&

(
?

(
?

(

?!

(
?$%

)??


)
?

)?

)?


)?

)
?

)?

)
?$

)
?


)
?

)

?

)
?"#

)?'

)?


)?

)
?"

)?%&

)?&

)?


)?

)
?!

)?$%

)?#

)?


)?

)
?

)?!"

)?!

)?


)?

)
?

)? 

)? 

)?


)?

)
?

)?

)?+

)?


)?

)
?&

)?)*

)?D

)?


)?

)
?-

)?01

)?2C

)?3B

)	?5

)	?


)	?

)	
?/

)	?24

)
?(

)
?


)
?

)

?"

)
?%'

)?"

)?


)?

)
?

)?!

)?4

)? 

)
?!.

)?13

)
?&

)
?


)
?

)

? 

)
?#%

*??


*
?

*?'

*?


*?

*
?"

*?%&

*
? 

*
?


*
?

*

?

*
?

*?'

*?


*?

*
?"

*?%&

*?

*?


*?

*
?

*?

*?%

*?


*?

*
? 

*?#$

+??


+
?

+?'

+?


+?

+
?"

+?%&

+
?!

+
?


+
?

+

?

+
? 

,??


,
?

,??

,
?

,?

,
?

,?

,
?

,

?

,
?

,?

,
?

,?

,?

,
?

,?
G
,?9 Type of element, either an operand kind or an operator.


,?


,?

,
?

,?
5
,
?' Operator symbol if type ``OPERATOR``.


,
?


,
?

,

?

,
?
3
,?% Constant if type ``VALUE_OPERAND``.


,?


,?

,
?

,?
D
,?'6 Parameter whose value is used if type ``PARAMETER``.


,?


,?

,
?"

,?%&
,
,?' Parameter instance specifier


,?


,?

,
?"

,?%&

-??


-
?

-??

-
?

-?

-
?


-?


-
?

-

?

-
?

-
??

-

?

-
?

-

?


-
?


-

?

-


?

-

?

-
?

-

?

-
?

-? Algorithm name


-?


-?

-
?

-?

-
?$

-
?


-
?

-

?

-
?"#

-?'

-?


-?

-
?"

-?%&

-?&

-?


-?

-
?!

-?$%

-?#

-?


-?

-
?

-?!"

-?

-?


-?

-
?

-?
!
-? Type of algorithm


-?


-?

-
?

-?
6
-?( Language if this is a custom algorithm


-?


-?

-
?

-?
2
-?$ Code if this is a custom algorithm


-?


-?

-
?

-?

-	?1

-	?


-	?

-	
?,

-	?/0

-
?4

-
?


-
?

-

?.

-
?13

-?0

-?


-?

-
?*

-?-/

-?%

-?


-?

-
?

-?"$
S
-
?)E Operands and operators in Reverse Polish Notation if type ``MATH``.


-
?


-
?

-

?#

-
?&(

.??


.
?
$
.? Yamcs instance name.


.?


.?

.
?

.?
X
.
?J The search keywords. This supports searching on qualified name or alias.


.
?


.
?

.

?

.
?
H
.?: Continuation token returned by a previous page response.


.?


.?

.
?

.?
^
.?P The zero-based row number at which to start outputting results. Default: ``0``


.?


.?

.
?

.?
?

.??
 The maximum number of returned systems per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``


.?


.?

.
?

.?

/??


/
?
$
/? Yamcs instance name.


/?


/?

/
?

/?
X
/
?J The search keywords. This supports searching on qualified name or alias.


/
?


/
?

/

?

/
?
?
/?? List only direct child sub-systems or containers of the specified system.
 For example when querying the system "/a" against an MDB with containers
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 container "/a/c".

 When ``system`` and ``q`` are used together, matching containers at any
 depth are returned, starting from the specified space system.


/?


/?

/
?

/?
H
/?: Continuation token returned by a previous page response.


/?


/?

/
?

/?
^
/?P The zero-based row number at which to start outputting results. Default: ``0``


/?


/?

/
?

/?
?

/??
 The maximum number of returned containers per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``


/?


/?

/
?

/?

0??


0
?!
$
0? Yamcs instance name.


0?


0?

0
?

0?
X
0
?J The search keywords. This supports searching on qualified name or alias.


0
?


0
?

0

?

0
?
?
0?? List only direct child sub-systems or parameter types of the specified system.
 For example when querying the system "/a" against an MDB with parameter types
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 parameter type "/a/c".

 When ``system`` and ``q`` are used together, matching containers at any
 depth are returned, starting from the specified space system.


0?


0?

0
?

0?
H
0?: Continuation token returned by a previous page response.


0?


0?

0
?

0?
^
0?P The zero-based row number at which to start outputting results. Default: ``0``


0?


0?

0
?

0?
?

0??
 The maximum number of returned items per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``


0?


0?

0
?

0?

1??


1
?
$
1? Yamcs instance name.


1?


1?

1
?

1?
X
1
?J The search keywords. This supports searching on qualified name or alias.


1
?


1
?

1

?

1
?
?
1?? List only direct child sub-systems or algorithms of the specified system.
 For example when querying the system "/a" against an MDB with algorithms
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 algorithm "/a/c".

 When ``system`` and ``q`` are used together, matching algorithms at any
 depth are returned, starting from the specified space system.


1?


1?

1
?

1?
H
1?: Continuation token returned by a previous page response.


1?


1?

1
?

1?
^
1?P The zero-based row number at which to start outputting results. Default: ``0``


1?


1?

1
?

1?
?

1??
 The maximum number of returned algorithms per page. Choose this value too
 high and you risk hitting the maximum response size limit enforced by
 the server. Default: ``100``


1?


1?

1
?

1?
>
1?*0 Include only algorithms of the specified scope


1?


1?

1
?$

1?')

2??


2
?
$
2? Yamcs instance name.


2?


2?

2
?

2?
X
2
?J The search keywords. This supports searching on qualified name or alias.


2
?


2
?

2

?

2
?
?
2?? List only direct child sub-systems or commands of the specified system.
 For example when querying the system "/a" against an MDB with commands
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 command "/a/c".

 When ``system`` and ``q`` are used together, matching commands at any
 depth are returned, starting from the specified space system.


2?


2?

2
?

2?

2?

2?


2?

2
?

2?
H
2?: Continuation token returned by a previous page response.


2?


2?

2
?

2?
^
2?P The zero-based row number at which to start outputting results. Default: ``0``


2?


2?

2
?

2?
?

2??
 The maximum number of returned commands per page. Choose this value too
 high and you risk hitting the maximum response size limit enforced by
 the server. Default: ``100``


2?


2?

2
?

2?
)
2?  Exclude abstract commands


2?


2?

2
?

2?

3??


3
?
$
3? Yamcs instance name.


3?


3?

3
?

3?

3
? Parameter name.


3
?


3
?

3

?

3
?

4??


4
?
$
4? Yamcs instance name.


4?


4?

4
?

4?
X
4
?J The search keywords. This supports searching on qualified name or alias.


4
?


4
?

4

?

4
?
?

4?#?
 When used together with ``q``, include also aggregate members (at any depth)
 in the search.

 Note that this method returns only parameters. Members are part of the type definition.


4?


4?

4
?

4? "
?

4??
 Include details on each returned parameter (this includes long
 descriptions, aliases, and detailed type information).
 If unset, only summary information is returned.


4?


4?

4
?

4?
?

4??
 The parameter types to be included in the result. Valid types are ``boolean``,
 ``binary``, ``enumeration``, ``float``, ``integer`` or ``string``.
 If unspecified, parameters of all types will be included.


4?


4?

4
?

4?
@
4?&2 Include only parameters of the specified source.


4?


4?

4
? 

4?#%
?
4?? List only direct child sub-systems or parameters of the specified system.
 For example when querying the system "/a" against an MDB with parameters
 "/a/b/c" and "/a/c", the result returns the sub system "/a/b" and the
 parameter "/a/c".

 When ``system`` and ``q`` are used together, matching parameters at any
 depth are returned, starting from the specified space system.


4?


4?

4
?

4?
H
4?: Continuation token returned by a previous page response.


4?


4?

4
?

4?
^
4?P The zero-based row number at which to start outputting results. Default: ``0``


4?


4?

4
?

4?
?

4	??
 The maximum number of returned parameters per page. Choose this value too
 high and you risk hitting the maximum response size limit enforced by the
 server. Default: ``100``


4	?


4	?

4	
?

4	?

5??


5
?
L
5?'> Matching subsystems when the ``system`` option was specified


5?


5?

5
?"

5?%&
3
5
?5% Deprecated. Use ``systems`` instead


5
?


5
?

5

?

5
?!"

5
?#4

5
?$3
#
5?( Matching parameters


5?


5?

5
?#

5?&'
?

5?(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.


5?


5?

5
?#

5?&'
>
5?0 The total number of results (across all pages)


5?


5?

5
?

5?

6??


6
?!

6?

6?


6?

6
?

6?

6
? 

6
?


6
?

6

?

6
?

7??


7
?"

7??

7
?


7?"

7?

7?


7
?

7? !

7
?)

7
?

7
?


7

?$

7
?'(

7?-

7?


7?

7
? (

7?+,

8??


8
?
L
8?'> Matching subsystems when the ``system`` option was specified


8?


8?

8
?"

8?%&
3
8
?5% Deprecated. Use ``systems`` instead


8
?


8
?

8

?

8
?!"

8
?#4

8
?$3
#
8?( Matching containers


8?


8?

8
?#

8?&'
?

8?(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.


8?


8?

8
?#

8?&'
>
8?0 The total number of results (across all pages)


8?


8?

8
?

8?

9??


9
?"
L
9?'> Matching subsystems when the ``system`` option was specified


9?


9?

9
?"

9?%&
3
9
?5% Deprecated. Use ``systems`` instead


9
?


9
?

9

?

9
?!"

9
?#4

9
?$3
(
9?0 Matching parameter types


9?


9?

9
?+

9?./
?

9?(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.


9?


9?

9
?#

9?&'
>
9?0 The total number of results (across all pages)


9?


9?

9
?

9?

:??


:
?
L
:?'> Matching subsystems when the ``system`` option was specified


:?


:?

:
?"

:?%&
3
:
?5% Deprecated. Use ``systems`` instead


:
?


:
?

:

?

:
?!"

:
?#4

:
?$3
!
:?$ Matching commands


:?


:?

:
?

:?"#
?

:?(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.


:?


:?

:
?#

:?&'
>
:?0 The total number of results (across all pages)


:?


:?

:
?

:?

;??


;
?
L
;?'> Matching subsystems when the ``system`` option was specified


;?


;?

;
?"

;?%&
3
;
?5% Deprecated. Use ``systems`` instead


;
?


;
?

;

?

;
?!"

;
?#4

;
?$3
#
;?( Matching algorithms


;?


;?

;
?#

;?&'
?

;?(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.


;?


;?

;
?#

;?&'
>
;?0 The total number of results (across all pages)


;?


;?

;
?

;?

<??


<
?
$
<? Yamcs instance name.


<?


<?

<
?

<?

<
? Algorithm name.


<
?


<
?

<

?

<
?

=??


=
?
#
=? Yamcs instance name


=?


=?

=
?

=?
.
=
?  Fully qualified parameter name


=
?


=
?

=

?

=
?
,
=?' Short description (one line)


=?


=?

=
?"

=?%&
+
=?& Long description (Markdown)


=?


=?

=
?!

=?$%
+
=?" Aliases, keyed by namespace


=?

=
?

=? !
?

=?)?
 Type of datasource.

 One of TELEMETERED, DERIVED, CONSTANT, LOCAL, SYSTEM, COMMAND, COMMAND_HISTORY,
 EXTERNAL1, EXTERNAL2, or EXTERNAL3


=?


=?

=
?$

=?'(
8
=?$* Fully qualified name of a parameter type


=?


=?

=
?

=?"#

>??	


>
?"
#
>? Yamcs instance name


>?


>?

>
?

>?
3
>
?% Fully qualified parameter type name


>
?


>
?

>

?

>
?
,
>?' Short description (one line)


>?


>?

>
?"

>?%&
+
>?& Long description (Markdown)


>?


>?

>
?!

>?$%
+
>?" Aliases, keyed by namespace


>?

>
?

>? !
y
>?k Engineering type. One of ``float``, ``integer``, ``enumeration``,
 ``binary``, ``boolean`` or ``string``.


>?


>?

>
?

>?
 
>?	 Engineering unit


>?	


>?	

>
?	

>?	
?

>?	s Set to true if the engineering type supports signed representation.
 (only used with ``integer`` parameter types)


>?	


>?	

>
?	

>?	
S
>?	&E Default Alarm, effective when no contextual alarm takes precedence.


>?	


>?	

>
?	!

>?	$%
!
>	?	/ Contextual alarms


>	?	


>	?	

>	
?	)

>	?	,.
U
>
?	,G Enumeration values.
 (only used with ``enumeration`` parameter types)


>
?	


>
?	

>

?	&

>
?	)+
f
>?	'X String representation of a boolean zero.
 (only used with ``boolean`` parameter types)


>?	


>?	

>
?	!

>?	$&
e
>?	&W String representation of a boolean one.
 (only used with ``boolean`` parameter types)


>?	


>?	

>
?	 

>?	#%

??	?	


?
?	!
$
??	 Yamcs instance name.


??	


??	

?
?	

??	

@?	?	


@
?	(
$
@?	 Yamcs instance name.


@?	


@?	

@
?	

@?	

A?	?	


A
?	$
$
A?	 Yamcs instance name.


A?	


A?	

A
?	

A?	
7
A
?	() Stream space systems. Default: ``true``


A
?	


A
?	

A

?	#

A
?	&'
4
A?	&& Stream containers. Default: ``true``


A?	


A?	

A
?	!

A?	$%
4
A?	&& Stream parameters. Default: ``true``


A?	


A?	

A
?	!

A?	$%
9
A?	*+ Stream parameter types. Default: ``true``


A?	


A?	

A
?	%

A?	()
2
A?	$$ Stream commands. Default: ``true``


A?	


A?	

A
?	

A?	"#
4
A?	&& Stream algorithms. Default: ``true``


A?	


A?	

A
?	!

A?	$%

B?	?	


B
?	

B?	?	

B
?	

B?	$ A space system


B?	

B
?	

B?	"#

B
?	 
 A container


B
?	

B

?	

B
?	

B?	 
 A parameter


B?	

B
?	

B?	
 
B?	( A parameter type


B?	

B
?	#

B?	&'

B?	 A command


B?	

B
?	

B?	

B?	  An algorithm


B?	

B
?	

B?	

C?	?	


C
?	 
&
C?	, Matching space systems


C?	


C?	

C
?	'

C?	*+
?

C
?	(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.


C
?	


C
?	

C

?	#

C
?	&'
>
C?	0 The total number of results (across all pages)


C?	


C?	

C
?	

C?	

D?	?	


D
?	
$
D?	 Yamcs instance name.


D?	


D?	

D
?	

D?	
"
D
?	 Space-system name.


D
?	


D
?	

D

?	

D
?	

E?	?	


E
?	
$
E?	 Yamcs instance name.


E?	


E?	

E
?	

E?	
"
E
?	 Space-system name.


E
?	


E
?	

E

?	

E
?	

F?	?	


F
?	
$
F?	 Yamcs instance name.


F?	


F?	

F
?	

F?	

F
?	 Command name.


F
?	


F
?	

F

?	

F
?	

G?	?



G
?	
!
G?	 Space system name


G?	


G?	

G
?	

G?	

G
?	$

G
?	


G
?	

G

?	

G
?	"#
,
G?	' Short description (one line)


G?	


G?	

G
?	"

G?	%&
+
G?	& Long description (Markdown)


G?	


G?	

G
?	!

G?	$%

G?	$

G?	


G?	

G
?	

G?	!#

G?


G?



G?


G
?


G?


G?
$

G?



G?


G
?


G?
!#

G?
$

G?



G?


G
?


G?
!#

G?
4

G?
 

G
?
!.

G?
13
?#
(yamcs/protobuf/instances/instances.protoyamcs.protobuf.instancesgoogle/protobuf/timestamp.protoyamcs/protobuf/mdb/mdb.proto4yamcs/protobuf/yamcsManagement/yamcsManagement.proto"?

YamcsInstance
name
 
(	RnameM
missionDatabase 
(2#.yamcs.protobuf.mdb.MissionDatabaseRmissionDatabaseM

processors (2-.yamcs.protobuf.yamcsManagement.ProcessorInfoR
processorsK
state 
(25.yamcs.protobuf.instances.YamcsInstance.InstanceStateRstate"
failureCause	 
(	RfailureCause<
missionTime
 
(2.google.protobuf.TimestampRmissionTimeK
labels (23.yamcs.protobuf.instances.YamcsInstance.LabelsEntryRlabels"
capabilities
 (	Rcapabilities
template 
(	Rtemplate]
templateArgs (29.yamcs.protobuf.instances.YamcsInstance.TemplateArgsEntryRtemplateArgs,
templateAvailable 
(RtemplateAvailable(
templateChanged 
(RtemplateChanged9
LabelsEntry
key
 
(	Rkey
value 
(	Rvalue:8
?
TemplateArgsEntry
key
 
(	Rkey
value 
(	Rvalue:8
"t

InstanceState
OFFLINE
INITIALIZING

INITIALIZED
STARTING
RUNNING
STOPPING

FAILED"?

InstanceTemplate
name
 
(	Rname 
description 
(	RdescriptionH
	variables (2*.yamcs.protobuf.instances.TemplateVariableR	variables"?

TemplateVariable
name
 
(	Rname
label 
(	Rlabel
type 
(	Rtype
help 
(	Rhelp
required 
(Rrequired
choices (	Rchoices
initial 
(	RinitialB&
org.yamcs.protobufBInstancesProtoP
J?
Z






!


+
	

+


/
	
/


"
	

"
	
)
	


&
	
>


8

































































 Instance name.













3










.


12

8




(


)3

67

$









!#
?

 #?
in case the state=FAILED, this field will indicate the cause of the failure
 the missionDatabase and other fields may not be filled when this happens


 


 


 

 !"

"6

"


"$


"%0

"35
?

&"?
 Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.


&


&

&!
6
)$) Feature capability hints for client use


)


)


)

)!#
E
, 8 Name of the template, if this instance was generated  


,


,


,

,
Y
	0(L Arguments used during template processing, if this instance
 was generated


	0

	
0"

	0%'
5

3'( Whether the template is stil available



3



3



3!


3$&
R
7%E Whether the template has changed since this instance was
 generated


7


7


7

7"$



:C





:


< Template name.



<



<



<


<
)


?" Human-friendly description




?




?




?



? !
@

B*3 List of variables that this template may expect  



B



B



B%


B()


EZ




E

G Variable name. 


G


G


G

G
/

J" Verbose name for use in UI forms



J



J



J


J
T
MG Type of variable (Java class extending org.yamcs.templating.Variable)


M


M


M

M
+
P Verbose user guidance (HTML)


P


P


P

P
6
S) Whether this variable is required input


S


S


S

S
$
V List of valid choices


V


V


V

V
0
Y# Initial value for use in UI forms


Y


Y


Y

Y
?6
0yamcs/protobuf/instances/instances_service.protoyamcs.protobuf.instancesgoogle/protobuf/empty.protoyamcs/api/annotations.proto(yamcs/protobuf/instances/instances.proto".
ListInstancesRequest
filter
 (	Rfilter"^
ListInstancesResponseE
	instances
 (2'.yamcs.protobuf.instances.YamcsInstanceR	instances"?
CreateInstanceRequest
name
 
(	Rname
template 
(	Rtemplatee
templateArgs (2A.yamcs.protobuf.instances.CreateInstanceRequest.TemplateArgsEntryRtemplateArgsS
labels (2;.yamcs.protobuf.instances.CreateInstanceRequest.LabelsEntryRlabels?
TemplateArgsEntry
key
 
(	Rkey
value 
(	Rvalue:8
9
LabelsEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?
ReconfigureInstanceRequest
instance
 
(	Rinstancej
templateArgs (2F.yamcs.protobuf.instances.ReconfigureInstanceRequest.TemplateArgsEntryRtemplateArgsX
labels (2@.yamcs.protobuf.instances.ReconfigureInstanceRequest.LabelsEntryRlabels?
TemplateArgsEntry
key
 
(	Rkey
value 
(	Rvalue:8
9
LabelsEntry
key
 
(	Rkey
value 
(	Rvalue:8
"i
ListInstanceTemplatesResponseH
	templates
 (2*.yamcs.protobuf.instances.InstanceTemplateR	templates"8
GetInstanceTemplateRequest
template
 
(	Rtemplate"0
GetInstanceRequest
instance
 
(	Rinstance"2
StartInstanceRequest
instance
 
(	Rinstance"1
StopInstanceRequest
instance
 
(	Rinstance"4
RestartInstanceRequest
instance
 
(	Rinstance2?
InstancesApi?

ListInstanceTemplates.google.protobuf.Empty7.yamcs.protobuf.instances.ListInstanceTemplatesResponse"??
/api/instance-templates?

GetInstanceTemplate4.yamcs.protobuf.instances.GetInstanceTemplateRequest*.yamcs.protobuf.instances.InstanceTemplate"(??$
"/api/instance-templates/{template}?


ListInstances..yamcs.protobuf.instances.ListInstancesRequest/.yamcs.protobuf.instances.ListInstancesResponse"??
/api/instancesh
SubscribeInstances.google.protobuf.Empty'.yamcs.protobuf.instances.YamcsInstance"ڒ
	instances0
?

GetInstance,.yamcs.protobuf.instances.GetInstanceRequest'.yamcs.protobuf.instances.YamcsInstance"??
/api/instances/{instance}?

CreateInstance/.yamcs.protobuf.instances.CreateInstanceRequest'.yamcs.protobuf.instances.YamcsInstance"??/api/instances:
*?

ReconfigureInstance4.yamcs.protobuf.instances.ReconfigureInstanceRequest'.yamcs.protobuf.instances.YamcsInstance".??*%/api/instances/{instance}:reconfigure:
*?


StartInstance..yamcs.protobuf.instances.StartInstanceRequest'.yamcs.protobuf.instances.YamcsInstance"%??!/api/instances/{instance}:start?

StopInstance-.yamcs.protobuf.instances.StopInstanceRequest'.yamcs.protobuf.instances.YamcsInstance"$?? /api/instances/{instance}:stop?

RestartInstance0.yamcs.protobuf.instances.RestartInstanceRequest'.yamcs.protobuf.instances.YamcsInstance"'??#!/api/instances/{instance}:restartB-
org.yamcs.protobufBInstancesServiceProtoP
J?
?







!


+
	

+


6
	
6


"
	

"
	
%
	


%
	
2


g





'
 List instance templates





1



XZ

?2XZ
?

	bf?
 Restart an instance

 If the instance state is RUNNING, the instance will be stopped and then
 restarted. Otherwise the instance will be started. Note that the Mission
 Database will also be reloaded before restart.


	
b

	b,

	b7D

	ce

	?2ce


ik




i

j

j


j


j

j



mo





m


n'


n



n



n"


n%&


q




q
6
s) **Required.** The name of the instance.


s


s


s

s
H

v; **Required.** The name of the template for this instance.



v



v



v


v
?

z' Arguments for substitution in the template definition. Each entry is
 keyed by the argument name. The value must be a string.


z


z"

z%&
?

~!?
 Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.


~


~

~ 

?
?




?
"
$
?
 Yamcs instance name.


?



?



?


?

?


?
' Arguments for substitution in the template definition. Each entry is
 keyed by the argument name. The value must be a string.



?




?
"


?
%&
?

?
!?
 Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.


?



?


?
 

?
?




?
%

?
*

?



?



?
%

?
()

?
?




?
"

?
 Template name.


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?


	?
?



	
?

$
	?
 Yamcs instance name.


	?



	?


	
?


	?

?
,yamcs/protobuf/replication/replication.protoyamcs.protobuf.replicationgoogle/protobuf/empty.protoyamcs/api/annotations.proto"?

ReplicationInfoK
masters
 (21.yamcs.protobuf.replication.ReplicationMasterInfoRmastersH
slaves (20.yamcs.protobuf.replication.ReplicationSlaveInfoRslaves"?

ReplicationMasterInfo
instance
 
(	Rinstance
streams (	Rstreams"
localAddress 
(	RlocalAddress$

remoteAddress 
(	R
remoteAddress
push 
(Rpush
pushTo 
(	RpushTo
localTx 
(RlocalTx
nextTx 
(RnextTx"?

ReplicationSlaveInfo
instance
 
(	Rinstance
streams (	Rstreams"
localAddress 
(	RlocalAddress$

remoteAddress 
(	R
remoteAddress
push 
(Rpush
pullFrom 
(	RpullFrom
tx 
(Rtx2?

ReplicationApiq
GetReplicationInfo.google.protobuf.Empty+.yamcs.protobuf.replication.ReplicationInfo"??
/api/replicationy
SubscribeReplicationInfo.google.protobuf.Empty+.yamcs.protobuf.replication.ReplicationInfo"ڒ
replication-info0
B(
org.yamcs.protobufBReplicationProtoP
J?
7






#


+
	

+


1
	
1


"
	

"
	
%
	


%








$
 Get replication info





.

9H



?2
+

 Receive replication updates







4


?E


FU





?2


 






-




 


!(

+,


+










 &


)*



",





"
"

$ Yamcs instance name



$



$



$


$



%



%




%




%



%


&#


&



&



&


&!"


'$


'



'



'


'"#


(


(



(



(


(


)


)



)



)


)


*


*



*



*


*


+


+



+



+


+


.7




.
"
0 Yamcs instance name


0


0


0

0


1


1



1



1


1

2#

2


2


2

2!"

3$

3


3


3

3"#

4

4


4


4

4

5

5


5


5

5

6

6


6


6

6
?
&yamcs/protobuf/time/time_service.protoyamcs.protobuf.timegoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.proto"?

LeapSecondsTableK
ranges
 (23.yamcs.protobuf.time.LeapSecondsTable.ValidityRangeRranges?


ValidityRange
start
 
(	Rstart
stop 
(	Rstop 
leapSeconds 
(RleapSeconds$

taiDifference 
(R
taiDifference"?

SetTimeRequest
instance 
(	Rinstance0
time0 
(2.google.protobuf.TimestampRtime0 
elapsedTime 
(RelapsedTime
speed 
(
Rspeed"P
SubscribeTimeRequest
instance
 
(	Rinstance
	processor 
(	R	processor"H
TimeInfo<
currentTime 
(2.google.protobuf.TimestampRcurrentTime2?
TimeApih
GetLeapSeconds.google.protobuf.Empty%.yamcs.protobuf.time.LeapSecondsTable"??
/api/leap-secondsr
SetTime#.yamcs.protobuf.time.SetTimeRequest.google.protobuf.Empty"*??&!/api/instances/{instance}:setTime:
*d

SubscribeTime).yamcs.protobuf.time.SubscribeTimeRequest.google.protobuf.Timestamp"
ڒ
time0
B(
org.yamcs.protobufBTimeServiceProtoP
J?
C









+
	

+


1
	
1


"
	

"
	
%
	

	)
	
%


%





$
 Get UTC leap seconds





*

5E



?2
4

& Set (simulation) time of an instance










'<





?2
$
 $ Receive time updates



 

 (

 39

 :S

!#

?2!#


'/




'

(-


(

*
)" UTC timestamp (unsmeared)


)

)



)

)
*

*" UTC timestamp (unsmeared)



*


*




*


*

+#

+

+



+

+!"

,%

,

,



, 

,#$

.$

.


.


.

."#



17





1
"

3 Yamcs instance name



3



3



3


3



4/



4




4$




4%*



4-.


5!


5



5



5


5 


6


6



6



6


6


9?




9
"
; Yamcs instance name


;


;


;

;


>  Processor name



>



>



>


>


AC




A

B5

B


B$


B%0

B34
?
)yamcs/protobuf/iam/sessions_service.protoyamcs.protobuf.iamgoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.proto"S
ListSessionsResponse;
sessions
 (2.yamcs.protobuf.iam.SessionInfoRsessions"?
SessionInfo
id
 
(	Rid
username 
(	Rusername
	ipAddress 
(	R	ipAddress
hostname 
(	Rhostname8
	startTime 
(2.google.protobuf.TimestampR	startTimeB
lastAccessTime 
(2.google.protobuf.TimestampRlastAccessTimeB
expirationTime 
(2.google.protobuf.TimestampRexpirationTime
clients (	Rclients"0
SessionEventInfo
	endReason
 
(	R	endReason2?

SessionsApie
ListSessions.google.protobuf.Empty(.yamcs.protobuf.iam.ListSessionsResponse"??

/api/sessionsa
SubscribeSession.google.protobuf.Empty$.yamcs.protobuf.iam.SessionEventInfo"
ڒ	
session0
B,
org.yamcs.protobufBSessionsServiceProtoP
J?	
1









+
	

+


5
	
5


"
	

"
	
%
	

	)
	
%









 List sessions





(

3G



?2
:

, Receive notification when own session ends







,


7=


>N





?2


!






 $

 


 


 

 "#



#-





#
!

% Session identifier



%



%



%


%



&



&




&




&



&


' 


'



'



'


'


(


(



(



(


(


)3


)



)$



)%.


)12


*8


*



*$



*%3


*67


+8


+



+$



+%3


+67


,


,



,



,


,


/1




/

0 

0


0


0

0
?

yamcs/protobuf/iam/iam.protoyamcs.protobuf.iamyamcs/api/annotations.protoyamcs/protobuf/mdb/mdb.protogoogle/protobuf/timestamp.protogoogle/protobuf/empty.proto"G
ListUsersResponse2
users
 (2.yamcs.protobuf.iam.UserInfoRusers"K
ListGroupsResponse5
groups
 (2.yamcs.protobuf.iam.GroupInfoRgroups"?

CreateGroupRequest
name
 
(	Rname 
description 
(	Rdescription
users (	Rusers(
serviceAccounts (	RserviceAccounts"%
GetGroupRequest
name
 
(	Rname"(
DeleteGroupRequest
name
 
(	Rname"?
UpdateGroupRequest
name
 
(	Rname
newName 
(	RnewName 
description 
(	RdescriptionQ

memberInfo 
(21.yamcs.protobuf.iam.UpdateGroupRequest.MemberInfoR
memberInfoL

MemberInfo
users
 (	Rusers(
serviceAccounts (	RserviceAccounts"o
ListServiceAccountsResponseP
serviceAccounts
 (2&.yamcs.protobuf.iam.ServiceAccountInfoRserviceAccounts".
GetServiceAccountRequest
name
 
(	Rname"1
CreateServiceAccountRequest
name
 
(	Rname"?

CreateServiceAccountResponse
name
 
(	Rname$

applicationId 
(	R
applicationId,
applicationSecret 
(	RapplicationSecret"1
DeleteServiceAccountRequest
name
 
(	Rname"$
GetUserRequest
name
 
(	Rname"'
DeleteUserRequest
name
 
(	Rname"?

CreateUserRequest
name
 
(	Rname 
displayName 
(	RdisplayName
email 
(	Remail 
password 
(	B??
Rpassword"?
UpdateUserRequest
name
 
(	Rname 
displayName 
(	RdisplayName
email 
(	Remail
active 
(Ractive
	superuser 
(R	superuser 
password 
(	B??
RpasswordJ
roleAssignment 
(2".yamcs.protobuf.iam.RoleAssignmentRroleAssignment"&
RoleAssignment
roles
 (	Rroles"?
UserInfo
name 
(	Rname 
displayName 
(	RdisplayName
email 
(	Remail
active 
(Ractive
	superuser
 
(R	superuser:
	createdBy 
(2.yamcs.protobuf.iam.UserInfoR	createdBy>
creationTime 
(2.google.protobuf.TimestampRcreationTimeF
confirmationTime 
(2.google.protobuf.TimestampRconfirmationTime@

lastLoginTime 
(2.google.protobuf.TimestampR
lastLoginTime*
systemPrivileges (	RsystemPrivilegesS
objectPrivileges (2'.yamcs.protobuf.iam.ObjectPrivilegeInfoRobjectPrivileges5
groups (2.yamcs.protobuf.iam.GroupInfoRgroupsH

identities (2(.yamcs.protobuf.iam.ExternalIdentityInfoR
identities2
roles (2.yamcs.protobuf.iam.RoleInfoRrolesX
	clearance 
(2:.yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelTypeR	clearance"G
DeleteIdentityRequest
name
 
(	Rname
provider 
(	Rprovider"N
ExternalIdentityInfo
identity
 
(	Ridentity
provider 
(	Rprovider"E
DeleteRoleAssignmentRequest
name
 
(	Rname
role 
(	Rrole"?

	GroupInfo
name
 
(	Rname 
description 
(	Rdescription2
users (2.yamcs.protobuf.iam.UserInfoRusersP
serviceAccounts (2&.yamcs.protobuf.iam.ServiceAccountInfoRserviceAccounts"?
ServiceAccountInfo
name
 
(	Rname 
displayName 
(	RdisplayName
active 
(Ractive:
	createdBy 
(2.yamcs.protobuf.iam.UserInfoR	createdBy>
creationTime 
(2.google.protobuf.TimestampRcreationTimeF
confirmationTime 
(2.google.protobuf.TimestampRconfirmationTime@

lastLoginTime 
(2.google.protobuf.TimestampR
lastLoginTime"C
ObjectPrivilegeInfo
type
 
(	Rtype
objects (	Robjects"D
ListPrivilegesResponse*
systemPrivileges
 (	RsystemPrivileges"$
GetRoleRequest
name
 
(	Rname"G
ListRolesResponse2
roles
 (2.yamcs.protobuf.iam.RoleInfoRroles"?

RoleInfo
name
 
(	Rname 
description 
(	Rdescription*
systemPrivileges (	RsystemPrivilegesS
objectPrivileges (2'.yamcs.protobuf.iam.ObjectPrivilegeInfoRobjectPrivileges
default 
(Rdefault2?
IamApik
ListPrivileges.google.protobuf.Empty*.yamcs.protobuf.iam.ListPrivilegesResponse"??
/api/privileges\
	ListRoles.google.protobuf.Empty%.yamcs.protobuf.iam.ListRolesResponse"??

/api/rolesd
GetRole".yamcs.protobuf.iam.GetRoleRequest.yamcs.protobuf.iam.RoleInfo"??
/api/roles/{name}?

DeleteRoleAssignment/.yamcs.protobuf.iam.DeleteRoleAssignmentRequest.google.protobuf.Empty"L??H"/api/users/{name}/roles/{role}b&Role '{role}' deleted from user {name}\
	ListUsers.google.protobuf.Empty%.yamcs.protobuf.iam.ListUsersResponse"??

/api/usersd
GetUser".yamcs.protobuf.iam.GetUserRequest.yamcs.protobuf.iam.UserInfo"??
/api/users/{name}}

CreateUser%.yamcs.protobuf.iam.CreateUserRequest.yamcs.protobuf.iam.UserInfo"*??&
/api/users:
*bUser '{name}' created?


UpdateUser%.yamcs.protobuf.iam.UpdateUserRequest.yamcs.protobuf.iam.UserInfo"5??1*/api/users/{name}:
*bUser '{name}' was changedS

GetOwnUser.google.protobuf.Empty.yamcs.protobuf.iam.UserInfo"??
	/api/user{

DeleteUser%.yamcs.protobuf.iam.DeleteUserRequest.google.protobuf.Empty".??*"/api/users/{name}bUser '{name}' deleted?

DeleteIdentity).yamcs.protobuf.iam.DeleteIdentityRequest.google.protobuf.Empty"_??["'/api/users/{name}/identities/{provider}b0Identity '{provider}' deleted from user '{name}'_

ListGroups.google.protobuf.Empty&.yamcs.protobuf.iam.ListGroupsResponse"??
/api/groupsh
GetGroup#.yamcs.protobuf.iam.GetGroupRequest.yamcs.protobuf.iam.GroupInfo"??
/api/groups/{name}?

CreateGroup&.yamcs.protobuf.iam.CreateGroupRequest.yamcs.protobuf.iam.GroupInfo",??(/api/groups:
*bGroup '{name}' created?

UpdateGroup&.yamcs.protobuf.iam.UpdateGroupRequest.yamcs.protobuf.iam.GroupInfo"7??3*/api/groups/{name}:
*bGroup '{name}' was changed?

DeleteGroup&.yamcs.protobuf.iam.DeleteGroupRequest.yamcs.protobuf.iam.GroupInfo"0??,"/api/groups/{name}bGroup '{name}' deleted{
ListServiceAccounts.google.protobuf.Empty/.yamcs.protobuf.iam.ListServiceAccountsResponse"??
/api/service-accounts?

GetServiceAccount,.yamcs.protobuf.iam.GetServiceAccountRequest&.yamcs.protobuf.iam.ServiceAccountInfo""??
/api/service-accounts/{name}?

DeleteServiceAccount/.yamcs.protobuf.iam.DeleteServiceAccountRequest.google.protobuf.Empty"D??@"/api/service-accounts/{name}b Service account '{name}' deleted?

CreateServiceAccount/.yamcs.protobuf.iam.CreateServiceAccountRequest0.yamcs.protobuf.iam.CreateServiceAccountResponse"@??</api/service-accounts:
*b Service account '{name}' created??
IAMB 
org.yamcs.protobufBIamProtoP
J?T
?









+
	

+


)
	
)


"
	

"
	
%
	

	&
	

)
	
%
X
?

K Handles incoming requests related to Identity and Access Management (IAM)







#

?#

 List privileges





*

5K



?2


 List roles







%


0A





?2

 $ Get a role



 

 

 '/

!#

?2!#
(
', Delete a role assignment



'

'6

'AV

(+

?2(+

/3 List users



/

/%

/0A

02

?202

6: Get a user



6

6

6'/

79

?279

=C Create a user



=

="

=-5

>B

?2>B

FL Update a user



F

F"

F-5

GK

?2GK

OS Get own user



O

O&

O19

PR

?2PR

	V[ Delete a user


	
V

	V"

	V-B

	WZ

	?2WZ
+

^c Delete an external identity




^


^*


^5J


_b


?2_b

fj
 List groups



f

f&

f1C

gi

?2gi

mq
 Get a group



m

m

m)2

np

?2np


tz Create a group




t


t$


t/8


uy


?2uy

}?
 Update a group



}

}$

}/8

~?


?2~?

 
?
?
 Delete a group



?


?
$

?
/8

?
?


?2?
?

'
?
?
 List service accounts



?


?
/

?
:U

?
?


?2?
?

'
?
?
 Get a service account



?


?
0

?
;M

?
?


?2?
?

*
?
?
 Delete a service account



?


?
6

?
AV

?
?


?2?
?

*
?
?
 Create a service account



?


?
6

?
A]

?
?


?2?
?


?
?




?


?


?



?



?


?



?
?





?



?
 


?




?




?



?


?
?




?


?
 Group name


?



?



?


?

!

?
" Group description



?




?




?



?
 !
A
?
3 Usernames of users that should be added as member


?



?



?


?

H
?
&: Names of service accounts that should be added as member


?



?



?
!

?
$%

?
?




?


?
 Group name


?



?



?


?


?
?




?


?
 Group name


?



?



?


?


?
?




?


?
?



?



?


?


?




?


?



?
(


?



?





?
#


?
&'

?
 Group name


?



?



?


?



?
 New group name



?




?




?



?

!
?
" Group description


?



?



?


?
 !

?
% Group members


?



?



?
 

?
#$

?
?




?
#

?
2

?



?



?
-

?
01

?
?




?
 
$
?
 Service account name


?



?



?


?


?
?




?
#
$
?
 Service account name


?



?



?


?


	?
?



	
?
$
$
	?
 Service account name


	?



	?


	
?


	?


	
?
$

	
?



	
?


	

?


	
?
"#

	?
(

	?



	?


	
?
#

	?
&'


?
?





?
#
$

?
 Service account name



?




?




?



?


?
?




?


?

 Username


?



?



?


?


?
?



?


?
 Username


?


?


?

?


??




?


?
 Username



?



?



?


?



?" Display name




?




?




?



? !


? Email address



?



?



?


?


?E User password



?



?



?


?


?D


?3? C

??



?

?
 Username


?


?


?

?


?" Display name



?



?



?


? !

? Email address


?


?


?

?
*
? Whether the user may login


?


?


?

?
3
?% Whether the user has all privileges


?


?


?

?

?E User password


?


?


?

?

?D

?3? C

?- Assigned roles


?


?


?(

?+,

??



?

?

?


?


?

?

??



?

?
 Username


?


?


?

?


?# Displayed name



?



?



?


? "

? Email address


?


?


?

?
*
? Whether the user may login


?


?


?

?
3
?% Whether the user has all privileges


?


?


?

?
3
?#% User that created this user account


?


?


?

? "
*
?7 When this user was created


?


?$


?%1

?46
2
?;$ When this user was first activated


?


?$


?%5

?8:
-
?8 When this user last logged in


?


?$


?%2

?57
!
	?( System privileges


	?


	?

	
?"

	?%'
!

?5 Object privileges



?



?



?/


?24
2
?!$ Groups that this user is member of


?


?


?

? 
#
?0 External identities


?


?


? *

?-/


? Assigned roles



?



?



?


?
?

?E?
 Clearance level. If the command clearance feature is enabled,
 then this user attribute is used as an additional check whether
 the user may send certain commands.

 The command clearance feature is disabled by default.


?


?5


?6?

?BD

??



?

?
 Username


?


?


?

?
,

? Name of an identity provider



?



?



?


?

??



?
!
? External identity


?


?


?

?
-

? Name of the identity provider



?



?



?


?

??



?#

?
 Username


?


?


?

?


? Role name



?



?



?


?

??



?

? Group name


?


?


?

?
!

?" Group description



?



?



?


? !
3
?% Users that are member of this group


?


?


?

?
>
?20 Service accounts that are member of this group


?


?


?-

?01

??



?
$
? Service account name


?


?


?

?


?" Displayed name



?



?



?


? !
-
? Whether the account may login


?


?


?

?
3
?"% User that created this user account


?


?


?

? !
*
?6 When this user was created


?


?$


?%1

?45
5
?:' When this account was first activated


?


?$


?%5

?89
0
?7" When this account last logged in


?


?$


?%2

?56

??



?

? Privilege type


?


?


?

?
$

? Objects of this type



?



?



?


?

??



?

?'

?


?


?"

?%&

??



?

? Role name


?


?


?

?

??



?

?

?


?


?

?

??



?

? Role name


?


?


?

?
 

?" Role description



?



?



?


? !
!
?' System privileges


?


?


?"

?%&
!
?4 Object privileges


?


?


?/

?23
8
?* Whether this role is assigned by default


?


?


?

?
?H
yamcs/protobuf/tco/tco.protoyamcs.protobuf.tcoyamcs/api/annotations.protogoogle/protobuf/empty.protogoogle/protobuf/timestamp.proto"S
GetTcoConfigRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName"?

SetTcoConfigRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName5
config 
(2.yamcs.protobuf.tco.TcoConfigRconfig"O
TcoResetRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName"?

	TcoConfig
accuracy
 
(
Raccuracy
validity 
(
Rvalidity"
onboardDelay 
(
RonboardDelay

defaultTof 
(
R
defaultTof"S
GetTcoStatusRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName"?

SetCoefficientsRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceNameG
coefficients 
(2#.yamcs.protobuf.tco.TcoCoefficientsRcoefficients"?

AddTimeOfFlightIntervalsRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName=
	intervals (2.yamcs.protobuf.tco.TofIntervalR	intervals"?

"DeleteTimeOfFlightIntervalsRequest
instance
 
(	Rinstance 
serviceName 
(	RserviceName0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop"?

TcoCoefficients,
utc
 
(2.google.protobuf.TimestampRutc
obt 
(Robt
gradient 
(
Rgradient
offset 
(
Roffset"?

	TcoStatusG
coefficients
 
(2#.yamcs.protobuf.tco.TcoCoefficientsRcoefficientsF
coefficientsTime 
(2.google.protobuf.TimestampRcoefficientsTime
	deviation 
(
R	deviation7
samples (2.yamcs.protobuf.tco.TcoSampleRsamples"K
	TcoSample,
utc
 
(2.google.protobuf.TimestampRutc
obt 
(Robt"?

TofInterval6
ertStart
 
(2.google.protobuf.TimestampRertStart4
ertStop 
(2.google.protobuf.TimestampRertStop
polCoef (
RpolCoef2?
TimeCorrelationApi?

	GetConfig'.yamcs.protobuf.tco.GetTcoConfigRequest.yamcs.protobuf.tco.TcoConfig".??*
(/api/tco/{instance}/{serviceName}/config?

	SetConfig'.yamcs.protobuf.tco.SetTcoConfigRequest.google.protobuf.Empty"6??2(/api/tco/{instance}/{serviceName}/config:config?

	GetStatus'.yamcs.protobuf.tco.GetTcoStatusRequest.yamcs.protobuf.tco.TcoStatus".??*
(/api/tco/{instance}/{serviceName}/status?

SetCoefficients*.yamcs.protobuf.tco.SetCoefficientsRequest.google.protobuf.Empty"B??>./api/tco/{instance}/{serviceName}/coefficients:coefficientss
Reset#.yamcs.protobuf.tco.TcoResetRequest.google.protobuf.Empty"-??)'/api/tco/{instance}/{serviceName}:reset?

AddTimeOfFlightIntervals3.yamcs.protobuf.tco.AddTimeOfFlightIntervalsRequest.google.protobuf.Empty";??72/api/tco/{instance}/{serviceName}/tof:addIntervals:
*?

DeleteTimeOfFlightIntervals6.yamcs.protobuf.tco.DeleteTimeOfFlightIntervalsRequest.google.protobuf.Empty">??:5/api/tco/{instance}/{serviceName}/tof:deleteIntervals:
*B 
org.yamcs.protobufBTcoProtoP
J?2
?










+
	

+


)
	
)


"
	

"
	
%
	

%
	
	)
=
c
1Methods related to the Time Correlation Service.





z
l Get the TCO config

 Returns the TCO configuration comprising the accuracy, validity and the fixed delays.





#

.7



?2
k

!] Set the TCO config

 Set the TCO configuration. The configuration is not persisted on disk.







#


.C


 


?2 
?

'+?
 Get the TCO status

 Returns the TCO status comprising the currently used coefficients, the last computed deviation
 and the last received samples.



'

'#

'.7

(*

?2(*
?

27?
 Set the TCO coefficients

Manually set the coefficients to be used for time correlation. These will overwrite 
 the automatic computed coefficients.



2

2,

27L

36

?236
~
<@pReset the time correlation.

The current used TCO coefficients are removed together with all collected samples.



<

<

<&;

=?

?2=?
?
QV? Add intervals for the time of flight calculation.

 Each ``[ertStart, ertStop)`` interval contains a polynomial function used to compute the time of flight for the given ``ert``.
 The intervals can overlap and are sorted in descending order of the start time.
 The first (highest start time) interval where the requested ert fits, will be used for the calculation. 
 
 The formula used for calculating the time of flight for a frame/packet received
 at ``ert`` in the ``[ertStart, ertStop)`` interval is:
 
     ``delta = ert - ertStart``

     ``tof = polCoef[0] + polCoef[1] * delta + polCoef[2] * delta^2 + ...``
 
 The result of the polynomial is the ``tof`` expressed in seconds.




Q

Q>

QI^

RU

?2RU
?

\a?
 Delete intervals for the time of flight calculation.

 All the intervals with the start time
 falling in the requested [start, stop] interval will be removed. 



\!

\"D

\Od

]`

?2]`


ek




e
#
g Yamcs instance name.


g


g


g

g


j" service name.



j



j



j


j !



nw





n
#

p Yamcs instance name.



p



p



p


p



s" Service name.




s




s




s



s !
"

v configuration to set



v



v



v


v


y




y
#
{ Yamcs instance name.


{


{


{

{


~" Service name.



~



~



~


~ !

?
?




?


?


?



?



?


?



?



?




?




?



?


?
#

?



?



?


?
!"

?
!

?



?



?


?
 

?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
" Service name.



?




?




?



?
 !

?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
" Service name.



?




?




?



?
 !
-
?
,Time correlation coefficients	


?



?



?
'

?
*+

?
?




?
'
$
?
 Yamcs instance name.


?



?



?


?



?
" Service name.



?




?




?



?
 !
7
?
%)intervals for time of flight calculation


?



?



?
 

?
#$
X
?
?

JDelete all the TofIntervals having
 start <= tofInterval.ertStart <= stop



?
*
$
?
 Yamcs instance name.


?



?



?


?



?
" Service name.



?




?




?



?
 !

?
/

?



?
$


?
%*

?
-.

?
.

?



?
$


?
%)

?
,-

?
?




?


?
-

?



?
$


?
%(

?
+,


?



?




?




?



?


?


?



?



?


?


?


?



?



?


?

?

	?
?

?
If the TCO is used only for verifying the synchronization, the message will 
 contain only the validity, accuracy and deviation.
2'Current status of the Time Correlation


	
?

c
	?
,UCurrently used coefficients.
 If not present, the synchronization is not established


	?



	?


	
?
'

	?
*+
@
	
?
:2The time when the coefficients have been computed


	
?



	
?
$

	

?
%5

	
?
89
*
	?
 The last computed deviation


	?



	?


	
?


	?

?

	?
!?
The last accumulated samples
These are not necessary those from which the coefficients 
have been calculated because the coefficients will only 
be recalculated when the deviation is higher than the accuracy settings


	?



	?


	
?


	?
 
?


?
?

?
Sample association between UTC and Onboard time.
This is computed by the TCO service after adjusting for internal
delays and time of flight. 




?



?
-


?




?
$



?
%(


?
+,



?




?





?





?




?


?
?




?


?
2

?



?
$


?
%-

?
01


?
1


?




?
$



?
%,


?
/0

?


?



?



?


?

??
"yamcs/protobuf/pvalue/pvalue.protoyamcs.protobuf.pvalueyamcs/protobuf/yamcs.protoyamcs/protobuf/mdb/mdb.protogoogle/protobuf/timestamp.proto"?
ParameterValue-
id
 
(2.yamcs.protobuf.NamedObjectIdRid1
rawValue 
(2.yamcs.protobuf.ValueRrawValue1
engValue 
(2.yamcs.protobuf.ValueRengValueD
acquisitionTime 
(2.google.protobuf.TimestampRacquisitionTimeB
generationTime 
(2.google.protobuf.TimestampRgenerationTimeV
acquisitionStatus 
(2(.yamcs.protobuf.pvalue.AcquisitionStatusRacquisitionStatus.
processingStatus 
(B
RprocessingStatusS
monitoringResult 
(2'.yamcs.protobuf.pvalue.MonitoringResultRmonitoringResultM
rangeCondition	 
(2%.yamcs.protobuf.pvalue.RangeConditionRrangeCondition>

alarmRange (2.yamcs.protobuf.mdb.AlarmRangeR
alarmRange"
expireMillis 
(RexpireMillis
	numericId 
(
R	numericId"?


ParameterDataC
	parameter
 (2%.yamcs.protobuf.pvalue.ParameterValueR	parameter
group 
(	Rgroup&
generationTime 
(RgenerationTime
seqNum 
(RseqNum&
subscriptionId 
(RsubscriptionId"?

TimeSeries@
sample
 (2(.yamcs.protobuf.pvalue.TimeSeries.SampleRsample?

Sample.
time 
(2.google.protobuf.TimestampRtime
avg 
(
Ravg
min 
(
Rmin
max 
(
Rmax

n 
(R
n4
minTime 
(2.google.protobuf.TimestampRminTime4
maxTime 
(2.google.protobuf.TimestampRmaxTime"?
Ranges9
range
 (2#.yamcs.protobuf.pvalue.Ranges.RangeRrange?

Range0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
count 
(Rcount3
	engValues (2.yamcs.protobuf.ValueR	engValues
counts (Rcounts*M
AcquisitionStatus
ACQUIRED
NOT_RECEIVED

INVALID
EXPIRED*o
MonitoringResult
DISABLED
	IN_LIMITS
	
WATCH
WARNING

DISTRESS

CRITICAL

SEVERE*#
RangeCondition
LOW
HIGH
B
org.yamcs.protobufJ?0
?










+
	

+
	
$
	

&
	
)
4


(this can also be called validity status







 OK!






'

 No value received so far








:
- Some value has been received but is invalid






m
` The parameter is coming from a packet which has not since updated although it should have been











 



































	















































"%




"

#


#

#



$



$


$


'M




'
#
)" Parameter identifier


)

)



)

) !
'

,  Raw value (uncalibrated)



,


,




,


,
-
/   Engineering value (calibrated)


/

/



/

/
&
2; Time of Yamcs reception


2

2
&


2'6

29:
1
5:$ Time of generation (~ packet time)


5

5
&


5'5

589

75

7

7



70

734
?

<;?
 Deprecated: this field was originally introduced for compatibility
 with Airbus CGS/CD-MCS system. It was redundant, because when false,
 the acquisitionStatus is also set to INVALID.


<

<



<"

<%&

<':

<(9

=3

=

=



=.

=12

>/

>

>



>*

>-.
'
	A, Context-dependent ranges


	A

	A


	
A&

	A)+
?


F%?
 How long (in milliseconds) this parameter value is valid
 Note that there is an option when subscribing to parameters to get
 updated when the parameter values expire. 



F


F




F


F"$
?

L#?
 When transferring parameters over WebSocket, this value might be used
 instead of the id above in order to reduce the bandwidth.
 Note that the id <-> numericId assignment is only valid in the context
 of a single WebSocket call.


L

L



L

L "



Q^





Q


R*


R


R




R%


R()
?


X? The next three fields are used by the recorder as unique key to store
 parameters in "rows" and also by components that provide parameters
 from external sources. The time should roughly correspond to the parameter 
 time but can be rounded for better efficiency.




X



X





X



X


Y'


Y


Y




Y"


Y%&


Z


Z


Z




Z


Z
O

]&B Used when parameter data is delivered as result of subscriptions



]


]




]!


]$%


`{




`

aw


a
3
c4$ Start time of the sample interval.


c

c*


c+/

c23
B

f 3 Average numeric value during the sample interval.



f


f



f


f
B
i 3 Minimum numeric value during the sample interval.


i

i


i

i
B
l 3 Maximum numeric value during the sample interval.


l

l


l

l
j
p[ Number of samples during the sample interval.
 If this value is zero, it indicates a gap.


p

p


p

p
6
s7' Generation time of the ``min`` value.


s

s*


s+2

s56
6
v7' Generation time of the ``max`` value.


v

v*


v+2

v56

z List of samples.


z

z



z

z

}?





}

~?



~
7
?
5' Generation time of a parameter value.


?


?
*


?
+0

?
34
?


?
4?
 If the value changes, ``stop`` is the generation time of the new value.
 If the parameter expires or the ``maxGap`` has been set, ``stop`` is
 the generation time of the last value plus the expiration time or the
 ``maxGap``.



?



?
*



?
+/


?
23
?

?
!?
 Number of parameter values received in the interval.
 This is the total count of parameters in the interval.
 If the count does not match the sum(counts), it means that not all the values have been sent


?


?



?


?
 
?
?
%? Since Yamcs 5.4.1 there is a new parameter minRange in the GetParameterRangesRequest which allows 
 specifying the minimum length of the range returned.
 Practically we guarantee that stop-start >= minRange (mind the leap seconds!).

 If the minRange parameter is set, the returning ranges may include multiple values.
 These are given by the engValues and counts below. 

 Since Yamcs 5.4.2 there is a new parameter maxValues which allows to limit the number 
 of distinct values returned across all the ranges.
 In order to not return ranges containing no value, each range will have at least one value even if
 that will cause the total number of range values returned to exceed the maxValues parameter

 The counts correspond one to one to the engValues, the two arrays will always have the same length.


?


?



?
 

?
#$
C
?
"3 The counts correspond one to one to the engValues


?


?



?


?
 !

?


?


?




?


?

?]
$yamcs/protobuf/archive/archive.protoyamcs.protobuf.archivegoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/api/httpbody.proto"yamcs/protobuf/pvalue/pvalue.protoyamcs/protobuf/yamcs.proto"?

StreamParameterValuesRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop/
ids (2.yamcs.protobuf.NamedObjectIdRids
tmLinks (	RtmLinks",
ParameterGroupInfo
groups (	Rgroups"8
ListParameterGroupsRequest
instance
 
(	Rinstance"?
ListParameterHistoryRequest
instance
 
(	Rinstance
name 
(	Rname
pos 
(Rpos
limit 
(Rlimit
norepeat 
(Rnorepeat0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
order 
(	Rorder

norealtime	 
(R
norealtime
	processor
 
(	R	processor
source 
(	Rsource
maxBytes
 
(RmaxBytes
next 
(	Rnext"?

ListParameterHistoryResponseC
	parameter
 (2%.yamcs.protobuf.pvalue.ParameterValueR	parameter,
continuationToken 
(	RcontinuationToken"?
GetParameterSamplesRequest
instance
 
(	Rinstance
name 
(	Rname0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
count 
(Rcount

norealtime 
(R
norealtime 
useRawValue	 
(RuseRawValue
gapTime
 
(RgapTime
	processor 
(	R	processor
source 
(	Rsource"?
ExportParameterValuesRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop

parameters (	R
parameters
list 
(	Rlist
	namespace 
(	R	namespace
extra (	Rextra
	delimiter 
(	R	delimiter
interval 
(Rinterval,
preserveLastValue	 
(RpreserveLastValue
pos
 
(Rpos
limit 
(Rlimit
order 
(	Rorder
filename
 
(	Rfilename
header 
(	Rheader2?
StreamArchiveApi?

ListParameterGroups2.yamcs.protobuf.archive.ListParameterGroupsRequest*.yamcs.protobuf.archive.ParameterGroupInfo".??*
(/api/archive/{instance}/parameter-groups?

ListParameterHistory3.yamcs.protobuf.archive.ListParameterHistoryRequest4.yamcs.protobuf.archive.ListParameterHistoryResponse"7??3
1/api/stream-archive/{instance}/parameters/{name*}?

StreamParameterValues4.yamcs.protobuf.archive.StreamParameterValuesRequest$.yamcs.protobuf.pvalue.ParameterData"=??94/api/stream-archive/{instance}:streamParameterValues:
*0
?

GetParameterSamples2.yamcs.protobuf.archive.GetParameterSamplesRequest!.yamcs.protobuf.pvalue.TimeSeries"G??C
9/api/stream-archive/{instance}/parameters/{name*}/samplesRsample?

ExportParameterValues4.yamcs.protobuf.archive.ExportParameterValuesRequest.yamcs.api.HttpBody"g??c
-/api/archive/{instance}:exportParameterValuesZ2-/api/archive/{instance}:exportParameterValues:
*0
B
org.yamcs.protobufJ?F
?









+
	

+
	
)
	

%
	
	"
	

,
	
$



7






%
 List parameter groups





4

?Q



?2
&

 List parameter history







6


A]





?2
-
# Streams back parameter values





8

CI

J^

"

?2"
%
&+ Get parameter samples



&

&4

&?P

'*

?2'*
5
.6' Export parameter values in CSV format



.

.8

.CI

.J\

/5

?2/5
9
:M
- Retrieves parameters by performing a replay




:$
"
< Yamcs instance name


<


<


<

<


=/


=



=$



=%*


=-.

>.

>


>$


>%)

>,-
?
F!? 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.


F


F


F

F 
?
L? Since version 5.4.0, Yamcs records the name of the TM link on which
 a TM packet is received together with the packet (in the tm table).
 This option, if specified, allows retrieving as part of replay only
 the packets originally received on one of the links specified.


L


L


L

L



OS





O
$

R Parameter group names



R



R



R


R


UX




U"
"
W Yamcs instance name


W


W


W

W

Z?





Z#
"
\ Yamcs instance name


\


\


\

\


_ Parameter name



_



_



_


_
^
bQ The zero-based row number at which to start outputting results. Default: ``0``.


b


b


b

b
?

g?
 The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``.


g


g


g

g
R
jE Whether to filter out consecutive identical values. Default ``no``.


j


j


j

j
t
n/g Filter the lower bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.


n


n$


n%*

n-.
t
r.g Filter the upper bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.


r


r$


r%)

r,-
h
v[ The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``.


v


v


v

v
Z
yM Disable loading of parameters from the parameter cache. Default: ``false``.


y


y


y

y
g
	}!Z The name of the processor from which to use the parameter cache.
 Default: ``realtime``.


	}


	}

	
}

	} 
?

?
? Specifies how to retrieve the parameters. Either ``ParameterArchive`` or
 ``replay``. If ``replay`` is specified, a replay processor will be created
 and data will be processed with the active Mission Database. Note that this
 is much slower than receiving data from the ParameterArchive.

 Default: ``ParameterArchive``.



?




?




?



?

?

?
~ If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.


?



?



?


?

H
?
: Continuation token returned by a previous page response.


?



?



?


?


?
?




?
$

?
/

?



?
 


?
!*

?
-.
?


?
(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.



?




?




?
#


?
&'

?
?




?
"
#
?
 Yamcs instance name


?



?



?


?



?
 Parameter name



?




?




?



?

u
?
/g Filter the lower bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.


?



?
$


?
%*

?
-.
u
?
.g Filter the upper bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.


?



?
$


?
%)

?
,-
=
?
/ Number of intervals to use. Default: ``500``.


?



?



?


?

[
?
M Disable loading of parameters from the parameter cache. Default: ``false``.


?



?



?


?

r
?
 d Consider the raw value instead of the engineering value.
 Default is to use the engineering value 


?



?



?


?

?

?
?
 Milliseconds before a sample is considered expired. This property is
 used as a fallback, when the underlying parameter values have no
 implicit expiration time.

 Default: ``120000``.


?



?



?


?

h
?
 Z The name of the processor from which to use the parameter cache.
 Default: ``realtime``.


?



?



?


?

?
	?
? Specifies how to retrieve the parameters. Either ``ParameterArchive`` or
 ``replay``. If ``replay`` is specified, a replay processor will be created
 and data will be processed with the active Mission Database. Note that
 this is much slower than receiving data from the ParameterArchive.

 Default: ``ParameterArchive``.


	?



	?


	
?


	?


?
?



?
$
#
?
 Yamcs instance name


?



?



?


?

u

?
/g Filter the lower bound of the parameter's generation time.
 Specify a date string in ISO 8601 format.



?




?
$



?
%*


?
-.
u
?
.g Filter the upper bound of the parameter's generation time.
 Specify a date string in ISO 8601 format.


?



?
$


?
%)

?
,-
4
?
!& The parameters to add to the export.


?



?



?


?
 
?

?
?
 Identifier of a Parameter List, describing the parameters to
 export.

 This may be used as an alternative to the ``parameters`` field.


?



?



?


?

y
?
 k Namespace used to display parameter names in csv header.
 Only used when no parameter ids were specified.


?



?



?


?


?
q Extra columns added to the CSV output:

  * ``raw``: Raw parameter values
  * ``monitoring``: Monitoring status


?



?



?


?

`
?
 R Column delimiter. One of ``TAB``, ``COMMA`` or ``SEMICOLON``.
 Default: ``TAB``.


?



?



?


?

q
?
c When specified, only one value each for each interval is returned.
 The value is in milliseconds.


?



?



?


?

|
	?
&n If true, repeat the the previous value, if there is no value for
 the current timestamp. Default: ``false``.


	?



	?


	
?
!

	?
$%
_

?
Q The zero-based row number at which to start outputting results. Default: ``0``.



?




?




?



?

K
?
= The maximum number of returned records. Default: unlimited.


?



?



?


?

h
?
Z The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``asc``.


?



?



?


?

?


?
 u Preferred filename, this is returned in a Content-Disposition HTTP header.
 If unset, Yamcs will determine a name. 



?




?




?



?

?

?~ Header row to include in the response.
 One of ``QUALIFIED_NAME``, ``SHORT_NAME`` or ``NONE``.
 Default: ``QUALIFIED_NAME``.


?


?


?

?
ӎ

6yamcs/protobuf/archive/parameter_archive_service.protoyamcs.protobuf.archivegoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.proto$yamcs/protobuf/archive/archive.proto"yamcs/protobuf/pvalue/pvalue.protoyamcs/protobuf/yamcs.proto"9
SubscribeBackfillingRequest
instance
 
(	Rinstance"?
SubscribeBackfillingDataa
finished
 (2E.yamcs.protobuf.archive.SubscribeBackfillingData.BackfillFinishedInfoRfinished?

BackfillFinishedInfo0
start
 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop0
processedParameters 
(RprocessedParameters"?

RebuildRangeRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop"*
PurgeRequest
instance
 
(	Rinstance"?
GetParameterRangesRequest
instance
 
(	Rinstance
name 
(	Rname0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
minGap 
(RminGap
maxGap 
(RmaxGap

norealtime 
(R
norealtime
	processor 
(	R	processor
source	 
(	Rsource
minRange
 
(RminRange
	maxValues 
(R	maxValues"z
 GetArchivedParametersInfoRequest
instance
 
(	Rinstance

q 
(	R
q
system 
(	Rsystem
limit 
(Rlimit"?

#GetArchivedParameterSegmentsRequest
instance
 
(	Rinstance
pid 
(
Rpid0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop"?

ArchivedParameterInfo
pid
 
(
Rpid
fqn 
(	Rfqn4
rawType 
(2.yamcs.protobuf.Value.TypeRrawType4
engType 
(2.yamcs.protobuf.Value.TypeRengType
gids (
Rgids"o
ArchivedParametersInfoResponseM

parameters
 (2-.yamcs.protobuf.archive.ArchivedParameterInfoR
parameters"?

ArchiveParameterSegmentInfo
groupId
 
(
RgroupId0
start 
(2.google.protobuf.TimestampRstart,
end 
(2.google.protobuf.TimestampRend
count 
(
Rcount"?

!ArchivedParameterSegmentsResponseS

parameterInfo
 
(2-.yamcs.protobuf.archive.ArchivedParameterInfoR
parameterInfoO
segments (23.yamcs.protobuf.archive.ArchiveParameterSegmentInfoRsegments"P
 GetArchivedParameterGroupRequest
instance
 
(	Rinstance
gid 
(
Rgid"?

ArchivedParameterGroupResponse
gid
 
(
RgidM

parameters (2-.yamcs.protobuf.archive.ArchivedParameterInfoR
parameters"6
EnableBackfillingRequest
instance
 
(	Rinstance"7
DisableBackfillingRequest
instance
 
(	Rinstance2?
ParameterArchiveApi?

RebuildRange+.yamcs.protobuf.archive.RebuildRangeRequest.google.protobuf.Empty";??70/api/archive/{instance}/parameterArchive:rebuild:
*H
?

GetParameterSamples2.yamcs.protobuf.archive.GetParameterSamplesRequest!.yamcs.protobuf.pvalue.TimeSeries"@??<
2/api/archive/{instance}/parameters/{name*}/samplesRsample?

GetParameterRanges1.yamcs.protobuf.archive.GetParameterRangesRequest.yamcs.protobuf.pvalue.Ranges">??:
1/api/archive/{instance}/parameters/{name*}/rangesRrange?

ListParameterHistory3.yamcs.protobuf.archive.ListParameterHistoryRequest4.yamcs.protobuf.archive.ListParameterHistoryResponse"0??,
*/api/archive/{instance}/parameters/{name*}?

GetArchivedParametersInfo8.yamcs.protobuf.archive.GetArchivedParametersInfoRequest6.yamcs.protobuf.archive.ArchivedParametersInfoResponse">??:
8/api/archive/{instance}/parameterArchive/info/parameters?

GetArchivedParameterSegments;.yamcs.protobuf.archive.GetArchivedParameterSegmentsRequest9.yamcs.protobuf.archive.ArchivedParameterSegmentsResponse"C???
=/api/archive/{instance}/parameterArchive/info/segments/{pid*}?

GetArchivedParameterGroup8.yamcs.protobuf.archive.GetArchivedParameterGroupRequest6.yamcs.protobuf.archive.ArchivedParameterGroupResponse"A??=
;/api/archive/{instance}/parameterArchive/info/groups/{gid*}~
Purge$.yamcs.protobuf.archive.PurgeRequest.google.protobuf.Empty"7??3./api/archive/{instance}/parameterArchive:purge:
*?

DisableBackfilling1.yamcs.protobuf.archive.DisableBackfillingRequest.google.protobuf.Empty"D??@;/api/archive/{instance}/parameterArchive:disableBackfilling:
*?

EnableBackfilling0.yamcs.protobuf.archive.EnableBackfillingRequest.google.protobuf.Empty"C???:/api/archive/{instance}/parameterArchive:enableBackfilling:
*?

SubscribeBackfilling3.yamcs.protobuf.archive.SubscribeBackfillingRequest0.yamcs.protobuf.archive.SubscribeBackfillingData"ڒ
backfilling0
B4
org.yamcs.protobufBParameterArchiveServiceProtoP
J?k
?









+
	

+


=
	
=


"
	

"
	
%
	

	)
	
%
	
.
	

,
	
$

?






?
#? Rebuild range

 The back filler has to be enabled for this purpose. The back filling process does not
 remove data but just overwrites it. That means that if the parameter replay returns
 less parameters than originally stored in the archive, the old parameters will still
 be found in the archive.

 It also means that if a replay returns the parameter of a different type than
 originally stored, the old ones will still be stored. This is because the parameter
 archive treats parameter with the same name but different type as different parameters.
 Each of them is given an id and the id is stored in the archive.





&

1F

"

?2"
?

16? Get parameter samples

 This divides the query interval in a number of intervals and returns aggregated
 statistics (max, min, avg) about each interval.

 This operation is useful when making high-level overviews (such as plots) of a
 parameter's value over large time intervals without having to retrieve each
 and every individual parameter value.

 By default this operation fetches data from the parameter archive and/or
 parameter cache. If these services are not configured, you can still get
 correct results by specifying the option ``source=replay`` as detailed below.




1


14


1?P


25


?225
?
BG? Get parameter ranges

 A range is a tuple ``(start, stop, value, count)`` that represents the time
 interval for which the parameter has been steadily coming in with the same
 value. This request is useful for retrieving an overview for parameters that
 change unfrequently in a large time interval. For example an on/off status
 of a device, or some operational status. Two consecutive ranges containing
 the same value will be returned if there was a gap in the data. The gap is
 determined according to the parameter expiration time configured in the
 Mission Database.



B

B2

B=J

CF

?2CF
&
JN List parameter history



J

J6

JA]

KM

?2KM
?
gk? Get information about the archived parameters.

 Each combination of (parameter name, raw type, engineering type) is assigned a
 unique parameter id.
 
 The parameters are grouped such that the samples of all parameters from one group
 have the same timestamp. For example all parameters extracted from one TM packet
 have usually the same timestamp and are part of the same group.

 Each group is assigned a unique group id.

 A parameter can be part of multiple groups. For instance a parameter appearing
 in the header of a packet is part of all groups made by inherited containers
 (i.e. each packet with that header will compose another group).

 For each group, the parameter archive stores one common record for the timestamps
 and individual records for the raw and engineering values of each parameter. If a
 parameter appears in multiple groups, retrieving its value means combining
 (time-based merge operation). The records beloging to the groups in which the
 parameter appears.

 The response to this method contains the parameter id, name, engineering type,
 raw type and the groups of which this parameter is part of.



g

g @

gKi

hj

?2hj
?

os?
 For a given parameter id, get the list of segments available for that parameter.
 A segment contains multiple samples (maximum ~70 minutes) of the same parameter.



o"

o#F

oQr

pr

?2pr
\
vzN For a given group id, get the list of parameters which are part of the group



v

v @

vKi

wy

?2wy
?
?
?
? Removes all the parameter archive data and related metadata. All the filling operations are stopped before
 and started after the purge.

 The rebuild operation has to be called to rebuild the past segments of the archive.

 Starting with Yamcs 5.9.0 the Parameter Archive is stored into a different column family ``parameter_archive``.
 Storing data into a separate column family gives better performance and the Parameter Archive rebuild operations
 are less disturbing for the other data (TM, TC, Events...). If the archive is from a previous version of Yamcs,
 the purge/rebuild can be used to move the parameter archive from the default column family to the separate column family.



?


?


?
#8

?
?


?2?
?

?
?
?
? Disables the automatic backfilling (rebuilding) of the parameter archive.
 See :manual:`services/instance/parameter-archive-service/#backfiller-options`
 
 If the backfilling is already disabled, this operation has no effect.
 If there is a backfilling running, this call will not stop it. 

 Manual rebuild operations are still accepted.
  



?


?
2

?
=R

?
?


?2?
?

?

	?
?
?
 Enables the automatic backfilling (rebuilding) of the parameter archive. 
 If the backfilling is already enabled, this operation has no effect.
  


	
?


	?
0

	?
;P

	?
?


	?2?
?

0

?
?
  Receive backfill notifications




?



?
6


?
AG


?
H`


?
?



?2?
?


?
?




?
#
#
?
 Yamcs instance name


?



?



?


?



?
?





?
 
?

?
?
/ Notification message when a backfill finished




?




?
1
 Range start



?



?

&



?
',


?
/0



?
0 Range stop




?




?

&




?
'+



?
./
0

?
,  Number of processed parameters



?



?





?
'


?
*+
N

?
-@ Recently finished backfills (bundled over a 5 second interval)



?




?




?
 (


?
+,
?

?
?

?
 Note that the archive is built in segments of approximatively 70 minutes,
 therefore the real start will be before the specified start and the real
 stop will be after the specified stop.



?

$
?
 Yamcs instance name.


?



?



?


?

U

?
/G Start rebuilding from here. Specify a date string in ISO 8601 format.



?




?
$



?
%*


?
-.
M
?
.? Rebuild until here. Specify a date string in ISO 8601 format.


?



?
$


?
%)

?
,-

?
?




?

$
?
 Yamcs instance name.


?



?



?


?


?
?



?
!
$
?
 Yamcs instance name.


?



?



?


?



?
 Parameter name.



?




?




?



?

u
?
/g Filter the lower bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.


?



?
$


?
%*

?
-.
u
?
.g Filter the upper bound of the parameter's generation time. Specify a date
 string in ISO 8601 format.


?



?
$


?
%)

?
,-
?

?
?
 Time in milliseconds. Any gap (detected based on parameter expiration) smaller than
 this will be ignored. However if the parameter changes value, the ranges will still
 be split.


?



?



?


?

?
?
? Time in milliseconds. If the distance between two subsequent values of the parameter
 is bigger than this value (but smaller than the parameter expiration), then an
 artificial gap will be constructed. This also applies if there is no parameter
 expiration defined for the parameter.


?



?



?


?

[
?
M Disable loading of parameters from the parameter cache. Default: ``false``.


?



?



?


?

g
?
 Y The name of the processor from which to use the parameter cache. Default: ``realtime``.


?



?



?


?

?
?
? Specifies how to retrieve the parameters. Either ``ParameterArchive`` or
 ``replay``. If ``replay`` is specified, a replay processor will be created
 and data will be processed with the active Mission Database. Note that this
 is much slower than receiving data from the ParameterArchive.

 Default: ``ParameterArchive``.


?



?



?


?

?

	??
 Time in milliseconds of the minimum range to be returned. If the data changes more often,
a new range will not be created but the data will be added to the old range.


	?


	?

	
?

	?
?

? ? Maximum number of distinct values to be returned. The maximum number
 applies across all ranges and is meant to limit the amount of data that
 is being retrieved. The retrieved data has a count for each value as well
 as a total count. The difference between the total count and the sum of the
 individual counts can be used to compute the number of unsent values.



?



?



?


?
U
??
G Get information about the parameters stored in the Parameter Archive 



?(
$
? Yamcs instance name.


?


?


?

?
$

? The search keywords.



?



?



?


?
?
?? List only direct child parameters of the specified system. 
 Only the parameters whose fully qualified name start with system will be returned.

 When ``system`` and ``q`` are used together, the q search will be matched on the parameters 
 filtered by system.


?


?


?

?
?

??
 The maximum number of returned parameters. Choose this value too
 high and you risk hitting the maximum response size limit enforced by the
 server. Default: ``100``


?


?


?

?

??



?+
$
? Yamcs instance name.


?


?


?

?


?
parameter id



?



?



?


?
G
?/9get the segments overlapping with [start, stop) interval


?


?$


?%*

?-.

?.

?


?$


?%)

?,-
?
??
? This message contains information about one parameter in the parameter archive.
 Each (parameter name, raw type, engineering type) is assigned a unique id and all 
 the samples are stored with that id. 
 If a MDB change results in the parameter having a different engineering or raw type, 
 a new pid will be allocated.
 This is why for the same parameter name, we can have multiple parameter ids.
 The parameter archive will contain data even for parameters removed from the MDB



?

?
parameter id


?


?


?

?
-

?parameter fully qualified name



?



?



?


?
"
?" parameter raw type


?


?


?

? !
)
?"parameter engineering type


?


?


?

? !
9
?+the groups which this parameter is part of


?


?


?

?

??



?&

?6

?

?&


?'1

?45

	??


	
?#
?
	?? Multiple parameters are grouped such that all in one group have
 the same timestamps. For example: all parameters extracted from
 one TM packet usually have the same timestamp.
 This way we have a unique segment storing the timestamps for a
 group of parameters. The groupId can be used to retrieve all parameters
 from the same group.


	?


	?

	
?

	?
 
	
?/the segment start


	
?


	
?$

	

?%*

	
?-.

	?-the segment end 


	?


	?$

	
?%(

	?+,
3
	?%the number of samples in the segment


	?


	?

	
?

	?
=

??
/ Recorded segments for the requested parameter




?)


?3


?



? 



?!.


?12



?4



?




?&




?'/



?23

??



?(
#
? Yamcs instance name


?


?


?

?
 

? Group identifier



?



?



?


?

??



?&
 
? Group identifier


?


?


?

?
1

?0# Parameters belonging to the group



?



? 



?!+


?./


??




? 
#

? Yamcs instance name



?



?



?


?

??



?!
#
? Yamcs instance name


?


?


?

?
??

*yamcs/protobuf/archive/index_service.protoyamcs.protobuf.archivegoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/protobuf/yamcs.proto"?

ListCommandHistoryIndexRequest
instance
 
(	Rinstance
	mergeTime 
(R	mergeTime
limit 
(Rlimit0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
next 
(	Rnext
name (	Rname"?

ListEventIndexRequest
instance
 
(	Rinstance
	mergeTime 
(R	mergeTime
limit 
(Rlimit0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
next 
(	Rnext
source (	Rsource"?

ListPacketIndexRequest
instance
 
(	Rinstance
	mergeTime 
(R	mergeTime
limit 
(Rlimit0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
next 
(	Rnext
name (	Rname"?

ListParameterIndexRequest
instance
 
(	Rinstance
	mergeTime 
(R	mergeTime
limit 
(Rlimit0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
next 
(	Rnext
group (	Rgroup"?

ListCompletenessIndexRequest
instance
 
(	Rinstance
	mergeTime 
(R	mergeTime
limit 
(Rlimit0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
next 
(	Rnext"w

IndexResponse8
group
 (2".yamcs.protobuf.archive.IndexGroupRgroup,
continuationToken 
(	RcontinuationToken"u

IndexGroup-
id
 
(2.yamcs.protobuf.NamedObjectIdRid8
entry (2".yamcs.protobuf.archive.IndexEntryRentry"?


IndexEntry
start
 
(	Rstart
stop 
(	Rstop
count 
(Rcount
seqStart 
(RseqStart
seqStop 
(RseqStop"?

StreamPacketIndexRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
names (	Rnames
	mergeTime 
(
R	mergeTime"?

StreamParameterIndexRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
	mergeTime 
(R	mergeTime"?

StreamCommandIndexRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
	mergeTime 
(R	mergeTime"?

StreamEventIndexRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
	mergeTime 
(R	mergeTime"?

StreamCompletenessIndexRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
	mergeTime 
(
R	mergeTime"?

RebuildCcsdsIndexRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop2?

IndexesApi?

ListCommandHistoryIndex6.yamcs.protobuf.archive.ListCommandHistoryIndexRequest%.yamcs.protobuf.archive.IndexResponse"+??'
%/api/archive/{instance}/command-index?

ListEventIndex-.yamcs.protobuf.archive.ListEventIndexRequest%.yamcs.protobuf.archive.IndexResponse")??%
#/api/archive/{instance}/event-index?

ListPacketIndex..yamcs.protobuf.archive.ListPacketIndexRequest%.yamcs.protobuf.archive.IndexResponse"*??&
$/api/archive/{instance}/packet-index?

ListParameterIndex1.yamcs.protobuf.archive.ListParameterIndexRequest%.yamcs.protobuf.archive.IndexResponse"-??)
'/api/archive/{instance}/parameter-index?

ListCompletenessIndex4.yamcs.protobuf.archive.ListCompletenessIndexRequest%.yamcs.protobuf.archive.IndexResponse"0??,
*/api/archive/{instance}/completeness-index?

StreamPacketIndex0.yamcs.protobuf.archive.StreamPacketIndexRequest.yamcs.protobuf.ArchiveRecord"2??.)/api/archive/{instance}:streamPacketIndex:
*0
?

StreamParameterIndex3.yamcs.protobuf.archive.StreamParameterIndexRequest.yamcs.protobuf.ArchiveRecord"5??1,/api/archive/{instance}:streamParameterIndex:
*0
?

StreamCommandIndex1.yamcs.protobuf.archive.StreamCommandIndexRequest.yamcs.protobuf.ArchiveRecord"3??/*/api/archive/{instance}:streamCommandIndex:
*0
?

StreamEventIndex/.yamcs.protobuf.archive.StreamEventIndexRequest.yamcs.protobuf.ArchiveRecord"1??-(/api/archive/{instance}:streamEventIndex:
*0
?

StreamCompletenessIndex6.yamcs.protobuf.archive.StreamCompletenessIndexRequest.yamcs.protobuf.ArchiveRecord"8??4//api/archive/{instance}:streamCompletenessIndex:
*0
?

RebuildCcsdsIndex0.yamcs.protobuf.archive.RebuildCcsdsIndexRequest.google.protobuf.Empty"G??C)/api/archive/{instance}:rebuildCcsdsIndex:
*jRebuild CCSDS IndexB)
org.yamcs.protobufBIndexServiceProtoP
J?]

?










+
	

+


2
	
2


"
	

"
	
	%
	


)
	
%
	

$


d





*
 List command history index





<

GT



?2
 

 List event index







*


5B





?2
!
 $ List packet index



 

 ,

 7D

!#

?2!#
$
'+ List parameter index



'

'2

'=J

(*

?2(*
'
.2 List completeness index



.

.8

.CP

/1

?2/1
1
5:# Streams back packet index records



5

50

5;A

5BO

69

?269
4
=B& Streams back parameter index records



=

=6

=AG

=HU

>A

?2>A
>
EJ0 Streams back processed parameter index records



E

E2

E=C

EDQ

FI

?2FI
0
MR" Streams back event index records



M

M.

M9?

M@M

NQ

?2NQ
0
	UZ" Streams back event index records


	
U

	U<

	UGM

	UN[

	VY

	?2VY
&

]c Rebuild CCSDS TM Index




]


]0


];P


^b


?2^b


f




f&
"
h Yamcs instance name


h


h


h

h
?


l?
 Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``



l



l



l


l
?
r? The maximum number of returned entries. Choose this value too high and you risk hitting
 the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via ``mergeTime``,
 rather than via ``limit``.


r


r


r

r
e
u/X Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.


u


u$


u%*

u-.
e
x.X Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.


x


x$


x%)

x,-
G
{: Continuation token returned by a previous page response.


{


{


{

{
+
~ Filter on a specific command


~


~


~

~


?
?





?

#

?
 Yamcs instance name



?




?




?



?

?



?
?
 Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``




?





?





?




?

?

?
? The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.



?




?




?



?

f

?
/X Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.



?




?
$



?
%*


?
-.
f

?
.X Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.



?




?
$



?
%)


?
,-
H

?
: Continuation token returned by a previous page response.



?




?




?



?

+

?
 Filter on specific sources.



?




?




?



?


?
?




?

#
?
 Yamcs instance name


?



?



?


?

?


?
?
 Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``



?




?




?



?

?
?
? The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.


?



?



?


?

f
?
/X Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.


?



?
$


?
%*

?
-.
f
?
.X Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.


?



?
$


?
%)

?
,-
H
?
: Continuation token returned by a previous page response.


?



?



?


?

0
?
" Filter on specific packet names.


?



?



?


?


?
?




?
!
#
?
 Yamcs instance name


?



?



?


?

?


?
?
 Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``20000``



?




?




?



?

?
?
? The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.


?



?



?


?

f
?
/X Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.


?



?
$


?
%*

?
-.
f
?
.X Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.


?



?
$


?
%)

?
,-
H
?
: Continuation token returned by a previous page response.


?



?



?


?

4
?
& Filter on specific parameter groups.


?



?



?


?


?
?




?
$
#
?
 Yamcs instance name


?



?



?


?

?


?
 Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: unset



?




?




?



?

?
?
? The maximum number of returned entries. Choose this value too high and you risk hitting
 the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via ``mergeTime``,
 rather than via ``limit``.


?



?



?


?

f
?
/X Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.


?



?
$


?
%*

?
-.
f
?
.X Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.


?



?
$


?
%)

?
,-
H
?
: Continuation token returned by a previous page response.


?



?



?


?


?
?




?


?
 

?



?



?


?

?


?
(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.



?




?




?
#


?
&'

?
?




?


?
 

?



?



?


?



?
 


?




?




?



?


?
?




?


?


?



?



?


?



?



?




?




?



?


?


?



?



?


?


?


?



?



?


?


?


?



?



?


?


??



? 
#
? Yamcs instance name


?


?


?

?
D

?/6 The time at which to start retrieving index records.



?



?$



?%*


?-.
C
?.5 The time at which to stop retrieving index records.


?


?$


?%)

?,-
/
?! Filter on specific packet names


?


?


?

?
~
? p Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together.


?


?


?

?

	??


	
?#
#
	? Yamcs instance name


	?


	?

	
?

	?
D
	
?/6 The time at which to start retrieving index records.


	
?


	
?$

	

?%*

	
?-.
C
	?.5 The time at which to stop retrieving index records.


	?


	?$

	
?%)

	?,-
~
	?p Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together.


	?


	?

	
?

	?


??




?!
#

? Yamcs instance name



?



?



?


?
D


?/6 The time at which to start retrieving index records.




?




?$




?%*



?-.
C

?.5 The time at which to stop retrieving index records.



?



?$



?%)


?,-
~

?p Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together.



?



?



?


?

??



?
#
? Yamcs instance name


?


?


?

?
D

?/6 The time at which to start retrieving index records.



?



?$



?%*


?-.
C
?.5 The time at which to stop retrieving index records.


?


?$


?%)

?,-
~
?p Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together.


?


?


?

?

??



?&
#
? Yamcs instance name


?


?


?

?
D

?/6 The time at which to start retrieving index records.



?



?$



?%*


?-.
C
?.5 The time at which to stop retrieving index records.


?


?$


?%)

?,-
~
? p Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together.


?


?


?

?


??




? 
#

? Yamcs instance name



?



?



?


?
'


?/ Range start (inclusive)




?




?$




?%*



?-.
&

?. Range stop (exclusive)



?



?$



?%)


?,-
?'
,yamcs/protobuf/archive/rocksdb_service.protoyamcs.protobuf.archivegoogle/protobuf/empty.protoyamcs/api/annotations.protoyamcs/api/httpbody.proto"q
ListRocksDbTablespacesResponseO
tablespaces
 (2-.yamcs.protobuf.archive.RocksDbTablespaceInfoRtablespaces"?

RocksDbTablespaceInfo
name
 
(	Rname
dataDir 
(	RdataDirI
	databases (2+.yamcs.protobuf.archive.RocksDbDatabaseInfoR	databases"i
ListRocksDbDatabasesResponseI
	databases
 (2+.yamcs.protobuf.archive.RocksDbDatabaseInfoR	databases"g
RocksDbDatabaseInfo

tablespace
 
(	R
tablespace
dataDir 
(	RdataDir
dbPath 
(	RdbPath"m
BackupDatabaseRequest

tablespace
 
(	R
tablespace
dbpath 
(	Rdbpath
	backupDir 
(	R	backupDir"h
CompactDatabaseRequest

tablespace
 
(	R
tablespace
dbpath 
(	Rdbpath
cfname 
(	Rcfname"Q
DescribeDatabaseRequest

tablespace
 
(	R
tablespace
dbpath 
(	Rdbpath2?

RocksDbApi?

ListTablespaces.google.protobuf.Empty6.yamcs.protobuf.archive.ListRocksDbTablespacesResponse"&??"
 /api/archive/rocksdb/tablespaces?

BackupDatabase-.yamcs.protobuf.archive.BackupDatabaseRequest.google.protobuf.Empty"j??f2/api/archive/rocksdb/{tablespace}/{dbpath*}:backupb0Tablespace {tablespace} backed up to {backupDir}?


ListDatabases.google.protobuf.Empty4.yamcs.protobuf.archive.ListRocksDbDatabasesResponse"$?? 
/api/archive/rocksdb/databases?

CompactDatabase..yamcs.protobuf.archive.CompactDatabaseRequest.google.protobuf.Empty"p??l4/api/archive/rocksdb/{tablespace}/{dbpath**}:compact:
*H
b/Compaction triggered on tablespace {tablespace}u
DescribeRocksDb.google.protobuf.Empty.yamcs.api.HttpBody"5??1
/api/archive/rocksdb:describejDescribe RocksDB?

DescribeDatabase/.yamcs.protobuf.archive.DescribeDatabaseRequest.yamcs.api.HttpBody";??7
5/api/archive/rocksdb/{tablespace}/{dbpath**}:describe??
RocksDBB+
org.yamcs.protobufBRocksDbServiceProtoP
J?
}









+
	

+


4
	
4


"
	

"
	
%
	


%
	
"



J








'

?'
 
 List tablespaces





+

6T



?2


 Backup database







*


5J





?2

 $ List databases



 

 )

 4P

!#

?2!#
 
'. Compact database



'

',

'7L

(-

?2(-
9
16+ Get a text-dump with general RocksDB info



1

1+

16H

25

?225
?
EI? Get a text-dump describing a database

 This operation can be used to debug the inner workings of RocksDB database.
 For example the property rocksdb.estimate-table-readers-mem will provide an
 estimation of how much memory is used by the index and filter cache of
 RocksDB (note that the memory used by RocksDB is outside the java heap space).

 See also: https://github.com/facebook/rocksdb/blob/master/include/rocksdb/db.h

 The response contains a dump of various rocksdb properties for each column
 family. The single value properties are presented in a "name: value" list.
 The multiline properties are preceded by a line including the property name
 between dashes.



E

E.

E9K

FH

?2FH


LN




L&

M1

M


M 


M!,

M/0



PT





P


Q


Q



Q



Q


Q



R



R




R




R



R


S-


S



S



S(


S+,


VX




V$

W-

W


W


W(

W+,


Z^




Z

[!

[


[


[

[ 


\


\



\



\


\

]

]


]


]

]


`d




`

a!

a


a


a

a 


b


b



b



b


b

c 

c


c


c

c


fx




f

g!

g


g


g

g 


h


h



h



h


h
?
w? Column family

 Starting with Yamcs 5.9.0 the following column families are used:

 _metadata_
     Stores information about tables, partitions
 rt_data
     Stores the tm, pp and events tables
 parameter_archive
     Stores the parameter archive
 default
     Stores everything else: cmdhistory, alarms, completeness indices,
     timeline, activities, users, buckets, ...


w


w


w

w


z}




z

{!

{


{


{

{ 


|


|



|



|


|
?
.yamcs/protobuf/database/database_service.protoyamcs.protobuf.archivegoogle/protobuf/empty.protoyamcs/api/annotations.proto"[
ListDatabasesResponseB
	databases
 (2$.yamcs.protobuf.archive.DatabaseInfoR	databases"(
GetDatabaseRequest
name
 
(	Rname"?

DatabaseInfo
name
 
(	Rname
path 
(	Rpath

tablespace 
(	R
tablespace
tables (	Rtables
streams (	Rstreams2?

DatabaseApil

ListDatabases.google.protobuf.Empty-.yamcs.protobuf.archive.ListDatabasesResponse"??
/api/databases|
GetDatabase*.yamcs.protobuf.archive.GetDatabaseRequest$.yamcs.protobuf.archive.DatabaseInfo"??
/api/databases/{name}B&
org.yamcs.protobufBDbServiceProtoP
J?
3









+
	

+


/
	
/


"
	

"
	
%
	


%









 List databases





)

4I



?2


 Get database







$


/;





?2









&







!

$%



!$





!


# Database name



#



#



#


#


&3




&

( Database name


(


(


(

(


+ Path on server



+



+



+


+

,!

,


,


,

, 
3
/& Names of the tables in this database


/


/


/

/
4
2' Names of the streams in this database


2


2


2

2
?2
 yamcs/protobuf/links/links.protoyamcs.protobuf.linksyamcs/api/annotations.proto$yamcs/protobuf/actions/actions.protogoogle/protobuf/struct.proto".
ListLinksRequest
instance
 
(	Rinstance"I
ListLinksResponse4
links
 (2.yamcs.protobuf.links.LinkInfoRlinks"@
GetLinkRequest
instance
 
(	Rinstance
link 
(	Rlink"C
EnableLinkRequest
instance
 
(	Rinstance
link 
(	Rlink"D
DisableLinkRequest
instance
 
(	Rinstance
link 
(	Rlink"J
ResetLinkCountersRequest
instance
 
(	Rinstance
link 
(	Rlink"?

RunActionRequest
instance
 
(	Rinstance
link 
(	Rlink
action 
(	Raction1
message 
(2.google.protobuf.StructRmessage"A
	LinkEvent4
links (2.yamcs.protobuf.links.LinkInfoRlinks"3
SubscribeLinksRequest
instance
 
(	Rinstance"?
LinkInfo
instance
 
(	Rinstance
name 
(	Rname
type 
(	Rtype
spec 
(	Rspec
disabled 
(Rdisabled
status 
(	Rstatus 
dataInCount
 
(RdataInCount"
dataOutCount 
(RdataOutCount&
detailedStatus	 
(	RdetailedStatus

parentName 
(	R
parentName<
actions
 (2".yamcs.protobuf.actions.ActionInfoRactions-
extra 
(2.google.protobuf.StructRextra

parameters (	R
parametersJJ	2?
LinksApiz
	ListLinks&.yamcs.protobuf.links.ListLinksRequest'.yamcs.protobuf.links.ListLinksResponse"??
/api/links/{instance?}s
GetLink$.yamcs.protobuf.links.GetLinkRequest.yamcs.protobuf.links.LinkInfo""??
/api/links/{instance}/{link}?


EnableLink'.yamcs.protobuf.links.EnableLinkRequest.yamcs.protobuf.links.LinkInfo"@??<#/api/links/{instance}/{link}:enablebLink '{link}' enabled?

DisableLink(.yamcs.protobuf.links.DisableLinkRequest.yamcs.protobuf.links.LinkInfo"B??>$/api/links/{instance}/{link}:disablebLink '{link}' disabled?

ResetLinkCounters..yamcs.protobuf.links.ResetLinkCountersRequest.yamcs.protobuf.links.LinkInfo"0??,*/api/links/{instance}/{link}:resetCountersm
SubscribeLinks+.yamcs.protobuf.links.SubscribeLinksRequest.yamcs.protobuf.links.LinkEvent"ڒ
links0
?

	RunAction&.yamcs.protobuf.links.RunActionRequest.google.protobuf.Struct"j??f-/api/links/{instance}/{link}/actions/{action}:messageb,Action '{action}' performed on link '{link}'B/
org.yamcs.protobuf.linksBLinksServiceProtoP
J? 
?










1
	

1


2
	
2


"
	

"
	
%
	

	.
	
&


F






 List links





 

+<



?2


 Get a link










'/





?2

# Enable a link





"

-5

"

?2"

&+ Disable a link



&

&$

&/7

'*

?2'*
#
.2 Reset link counters



.

.0

.;C

/1

?2/1
$
59 Receive link updates



5

5*

55;

5
parent 
(2&.yamcs.protobuf.server.ThreadGroupInfoRparent"?


ThreadInfo
id
 
(Rid
name 
(	Rname
state 
(	Rstate
native 
(Rnative
	suspended 
(R	suspended<
group 
(2&.yamcs.protobuf.server.ThreadGroupInfoRgroup=
trace (2'.yamcs.protobuf.server.TraceElementInfoRtrace"?
GetServerInfoResponse"
yamcsVersion
 
(	RyamcsVersion
revision 
(	Rrevision
serverId 
(	RserverId2
defaultYamcsInstance 
(	RdefaultYamcsInstanceQ
plugins (27.yamcs.protobuf.server.GetServerInfoResponse.PluginInfoRpluginsf
commandOptions (2>.yamcs.protobuf.server.GetServerInfoResponse.CommandOptionInfoRcommandOptionst

PluginInfo
name
 
(	Rname 
description 
(	Rdescription
version 
(	Rversion
vendor 
(	Rvendorm
CommandOptionInfo
id
 
(	Rid 
verboseName 
(	RverboseName
type 
(	Rtype
help 
(	Rhelp"?
ClientConnectionInfo
id
 
(	Rid
open 
(Ropen
active 
(Ractive
writable 
(Rwritable$

remoteAddress 
(	R
remoteAddress
	readBytes 
(R	readBytes"
writtenBytes 
(RwrittenBytes&
readThroughput 
(RreadThroughput(
writeThroughput	 
(RwriteThroughput]
httpRequest
 
(2;.yamcs.protobuf.server.ClientConnectionInfo.HttpRequestInfoRhttpRequest
username 
(	Rusername?

HttpRequestInfo
protocol
 
(	Rprotocol
method 
(	Rmethod
uri 
(	Ruri
	keepAlive 
(R	keepAlive
	userAgent 
(	R	userAgent"?

SystemInfo"
yamcsVersion
 
(	RyamcsVersion
revision 
(	Rrevision
serverId 
(	RserverId
uptime 
(Ruptime
jvm 
(	Rjvm*
workingDirectory 
(	RworkingDirectory(
configDirectory 
(	RconfigDirectory$

dataDirectory	 
(	R
dataDirectory&
cacheDirectory
 
(	RcacheDirectory
os 
(	Ros
arch 
(	Rarch0
availableProcessors
 
(RavailableProcessors 
loadAverage 
(
RloadAverage

heapMemory 
(R
heapMemory&
usedHeapMemory 
(RusedHeapMemory$

maxHeapMemory 
(R
maxHeapMemory$

nonHeapMemory 
(R
nonHeapMemory,
usedNonHeapMemory 
(RusedNonHeapMemory*
maxNonHeapMemory 
(RmaxNonHeapMemory&
jvmThreadCount 
(RjvmThreadCountN
rootDirectories (2$.yamcs.protobuf.server.RootDirectoryRrootDirectories<
process 
(2".yamcs.protobuf.server.ProcessInfoRprocess"?


RootDirectory
	directory
 
(	R	directory
type 
(	Rtype

totalSpace 
(R
totalSpace*
unallocatedSpace 
(RunallocatedSpace 
usableSpace 
(RusableSpace"?
ProcessInfo
pid
 
(Rpid
user 
(	Ruser
command 
(	Rcommand
	arguments (	R	arguments8
	startTime 
(2.google.protobuf.TimestampR	startTimeE
totalCpuDuration 
(2.google.protobuf.DurationRtotalCpuDuration>
children (2".yamcs.protobuf.server.ProcessInfoRchildren2?
	ServerApia

GetServerInfo.google.protobuf.Empty,.yamcs.protobuf.server.GetServerInfoResponse"
??
/api^

GetSystemInfo.google.protobuf.Empty!.yamcs.protobuf.server.SystemInfo"??
/api/sysinfoa
SubscribeSystemInfo.google.protobuf.Empty!.yamcs.protobuf.server.SystemInfo"
ڒ	
sysinfo0
b

ListRoutes.google.protobuf.Empty).yamcs.protobuf.server.ListRoutesResponse"??
/api/routesb

ListTopics.google.protobuf.Empty).yamcs.protobuf.server.ListTopicsResponse"??
/api/topicsx
ListThreads).yamcs.protobuf.server.ListThreadsRequest*.yamcs.protobuf.server.ListThreadsResponse"??
/api/threadsp
	GetThread'.yamcs.protobuf.server.GetThreadRequest!.yamcs.protobuf.server.ThreadInfo"??
/api/threads/{id}S
DumpThreads.google.protobuf.Empty.yamcs.api.HttpBody"??
/api/threads:dumpw
GetHttpTraffic.google.protobuf.Empty".yamcs.protobuf.server.HttpTraffic")??%
/api/http-trafficjGet HTTP Traffic?

SubscribeHttpTraffic.google.protobuf.Empty".yamcs.protobuf.server.HttpTraffic"*ڒ&
http-traffic"Subscribe HTTP Traffic0
B*
org.yamcs.protobufBServerServiceProtoP
J?]
?









+
	

+


3
	
3


"
	

"
	
(
	

	%
	

)
	
%
	

"
=
Y
1 Handles incoming requests related to api routes





'
 Get general server info





)

4I



?2


 Get system info







)


4>





?2
+
!% Receive system info updates



!

!/

!:@

!AK

"$

?2"$

(,
 List routes



(

(&

(1C

)+

?2)+

/3
 List topics



/

/&

/1C

02

?202

6: List threads



6

6$

6/B

79

?279
+
=A Get info on a single thread



=

= 

=+5

>@

?2>@
7
DH) Get a text-dump with thread information



D

D'

D2D

EG

?2EG
 
KP Get HTTP traffic



K

K*

K5@

LO

?2LO
,
	SX Receive HTTP traffic updates


	
S

	S0

	S;A

	SBM

	TW

	?2TW


[^




[

] Thread ID


]


]


]

]



`b





`


a"


a



a



a


a !


df




d

e 

e


e


e

e


hj




h

i 

i


i


i

i


lr




l

m 

m


m


m

m


n#


n



n



n


n!"

o%

o


o


o 

o#$

p&

p


p


p!

p$%

q0

q


q


q +

q./

t?





t

u

u


u


u

u


v


v



v



v


v

w"

w


w


w

w !

x!

x


x


x

x 

y

y


y


y

y

z 

z


z


z

z

{!

{


{


{

{ 

|

|


|


|

|

}"

}


}


}

} !

	~!

	~


	~

	
~

	~ 


!













 

?
?




?


?


?



?



?


?



?



?




?




?



?


?


?



?



?


?


?
"

?



?



?


?
 !

?
 

?



?



?


?


?
!

?



?



?


?
 

?


?



?



?


?


?
?




?


?
 

?



?



?


?



?



?




?




?



?


?
!

?



?



?


?
 

?
 

?



?



?


?


?
?




?

M
?
? Maximum depth of each thread's stacktrace. Default: no limit.


?



?



?


?


	?
?



	
?


	?


	?



	?


	
?


	?


	
?
&

	
?



	
?


	

?
!

	
?
$%


?
?





?



?



?




?




?



?




?




?





?





?




?



?



?




?




?



?



?



?




?




?



?



?



?




?




?



?



?
%


?




?




?
 


?
#$


?
&


?




?




?
!


?
$%

?
?




?


?
?



?



?


?


?




?


?



?
$


?



?





?



?
"#

?
 

?


?




?


?


?


?


?




?


?



?
?




?




?



?



?





?



?




?
$



?




?






?




?
"#


?



?



?





?



?



?



?



?





?



?

4
?
#& Yamcs version derived on build time.


?



?



?


?
!"
p

?
b Yamcs SHA-1 revision identifier. Set on
 build time, but only if the git command
 was available.



?




?




?



?

J
?
< An identifier for this server. Used in
 system parameters.


?



?



?


?

x
?
+j A default instance for this Yamcs installation.
 This is a calculated suggestion. UI clients may ignore.


?



?



?
&

?
)*
:
?
", Plugins loaded within this server instance


?



?



?


?
 !
8
?
0* Additional options available to commands


?



?



?
+

?
./

?
?




?


?
?



?



?
!

?


?




?


?
 


?



?



?





?



?


?


?


?




?


?


?
 

?


?




?


?


?
"

?


?




?


?
 !

?


?



?



?


?



?



?




?




?



?


?


?



?



?


?


?


?



?



?


?


?
$

?



?



?


?
"#

?
 

?



?



?


?


?
#

?



?



?


?
!"

?
%

?



?



?
 

?
#$

?
&

?



?



?
!

?
$%

	?
,

	?



	?


	
?
&

	?
)+


?
 


?




?




?



?



?
?




?

%

?
# Yamcs version number.



?




?




?



?
!"
2


?
$ Git revision number at build time.




?





?





?




?

W

?
I Server identifier, as used in system parameters and distributed setups.



?




?




?



?

0

?
" Uptime of Yamcs in milliseconds 



?




?




?



?

L

?
> Java virtual machine implementation name, version and vendor



?




?




?



?

N

?
'@ Working directory of Yamcs (base path for relative references)



?




?




?
"


?
%&
@

?
&2 Directory where configuration files are located.



?




?




?
!


?
$%
5

?
$' Directory where Yamcs data is stored.



?




?




?



?
"#
6

?
&( Directory where Yamcs may cache files.



?




?




?
 


?
#%
2

	?
$ Operating system name and version.



	?




	?



	
?



	?

.


?  Operating system architecture.




?




?




?



?
8

?** Number of processors available to Yamcs.



?



?



?$


?')
8

?#* System load average for the last minute.



?



?



?


? "
?



?!t Amount of memory in bytes of the heap that is used for object allocation and that is committed for the JVM to use.




?




?




?



? 
4

?%& Amount of used heap memory in bytes.



?



?



?


?"$
^

?$P Maximum amount of heap memory in bytes that can be used for memory management.



?



?



?


?!#
X

?$J Amount of non-heap memory in bytes that is committed for the JVM to use.



?



?



?


?!#
8

?(* Amount of non-heap used memory in bytes.



?



?



?"


?%'
b

?'T Maximum amount of non-heap memory in bytes that can be used for memory management.



?



?



?!


?$&
)

?% Number of active threads.



?



?



?


?"$
R

?.D Root directories, each corresponding to a distinct file hierarchy.



?



?



?(


?+-
H

?$: Information about the Yamcs process and any descendants.



?



?



?


?!#

??



?
(
?  Root directory location.


?


?


?

?
P

?B The type of the file store where this root directory is located.



?



?



?


?
U
? G Size in bytes of the file store where this root directory is located.


?


?


?

?
d
?&V Number of unallocated bytes in the file store where this root directory
 is located.


?


?


?!

?$%
k
?!] Number of bytes available to Yamcs on the file store where this root
 directory is located.


?


?


?

? 

??



?
"
? Native process ID.


?


?


?

?
$

? User of the process.



?



?



?


?
3
?% Executable pathname of the process.


?


?


?

?
)
?  Arguments of the process.


?


?


?

?
*
?3 Start time of the process.


?


?$


?%.

?12
*
?9 Accumulated total cputime.


?


?#


?$4

?78
/
?$! Direct children of the process.


?


?


?

?"#
?
yamcs/protobuf/auth/auth.protoyamcs.protobuf.authyamcs/protobuf/iam/iam.proto"?

AuthInfo4
requireAuthentication
 
(RrequireAuthentication
spnego 
(Rspnego>
openid 
(2&.yamcs.protobuf.auth.OpenIDConnectInfoRopenid"{
OpenIDConnectInfo
clientId
 
(	RclientId4
authorizationEndpoint 
(	RauthorizationEndpoint
scope 
(	Rscope"?


TokenResponse!
access_token
 
(	RaccessToken

token_type 
(	R	tokenType

expires_in 
(R	expiresIn#

refresh_token 
(	RrefreshToken0
user 
(2.yamcs.protobuf.iam.UserInfoRuserB!
org.yamcs.protobufB	AuthProtoP
J?
)









+
	

+


*
	
*


"
	

"
	
&











*







%

()
F

9 If true, the server is supportive of SPNEGO negotiation















?

(?
 OpenID Connect information. If used, the server expects
 web applications to generate an OAuth2 code directly against
 the upstream OpenID Connect server.








#

&'



 






Q

D The value provided when registering Yamcs against an OpenID server















9


,, Endpoint for for authentication or consent














'



*+
i

\ Scope for authorization requests (value to be interpreted by client-side web application) 















d
#)
X Naming conventions for this message follow RFC6749 - OAuth 2.0 Authorization Framework




#

$#

$


$


$

$!"


%!


%



%



%


% 

& " In seconds


&


&


&

&

'$

'


'


'

'"#

(!

(


(


(

( 
?^
2yamcs/protobuf/activities/activities_service.protoyamcs.protobuf.activitiesgoogle/protobuf/timestamp.protoyamcs/api/annotations.proto*yamcs/protobuf/activities/activities.proto"?
ListActivitiesRequest
instance
 
(	Rinstance
limit 
(Rlimit
order 
(	Rorder
status (	Rstatus
type (	Rtype
next 
(	Rnext0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop

q	 
(	R
q"L
GetActivityRequest
instance
 
(	Rinstance
activity 
(	Ractivity"O
GetActivityLogRequest
instance
 
(	Rinstance
activity 
(	Ractivity"X
GetActivityLogResponse>
logs
 (2*.yamcs.protobuf.activities.ActivityLogInfoRlogs"?

ListActivitiesResponseG

activities
 (2'.yamcs.protobuf.activities.ActivityInfoR
activities,
continuationToken 
(	RcontinuationToken"2
ListExecutorsRequest
instance
 
(	Rinstance"^
ListExecutorsResponseE
	executors
 (2'.yamcs.protobuf.activities.ExecutorInfoR	executors"0
ListScriptsRequest
instance
 
(	Rinstance"/
ListScriptsResponse
scripts
 (	Rscripts"?

StartActivityRequest
instance
 
(	Rinstancea
activityDefinition 
(21.yamcs.protobuf.activities.ActivityDefinitionInfoRactivityDefinition"O
CancelActivityRequest
instance
 
(	Rinstance
activity 
(	Ractivity"}
CompleteManualActivityRequest
instance
 
(	Rinstance
activity 
(	Ractivity$

failureReason 
(	R
failureReason"8
SubscribeActivitiesRequest
instance
 
(	Rinstance"U
SubscribeActivityLogRequest
instance
 
(	Rinstance
activity 
(	Ractivity":
SubscribeGlobalStatusRequest
instance
 
(	Rinstance":
GlobalActivityStatus"
ongoingCount
 
(RongoingCount2?

ActivitiesApi?

ListActivities0.yamcs.protobuf.activities.ListActivitiesRequest1.yamcs.protobuf.activities.ListActivitiesResponse"+??'
%/api/activities/{instance}/activities?

GetActivity-.yamcs.protobuf.activities.GetActivityRequest'.yamcs.protobuf.activities.ActivityInfo"6??2
0/api/activities/{instance}/activities/{activity}?

GetActivityLog0.yamcs.protobuf.activities.GetActivityLogRequest1.yamcs.protobuf.activities.GetActivityLogResponse":??6
4/api/activities/{instance}/activities/{activity}/log?


StartActivity/.yamcs.protobuf.activities.StartActivityRequest'.yamcs.protobuf.activities.ActivityInfo"???;%/api/activities/{instance}/activities:activityDefinition?

CancelActivity0.yamcs.protobuf.activities.CancelActivityRequest'.yamcs.protobuf.activities.ActivityInfo"=??97/api/activities/{instance}/activities/{activity}:cancel?

CompleteManualActivity8.yamcs.protobuf.activities.CompleteManualActivityRequest'.yamcs.protobuf.activities.ActivityInfo"B??>9/api/activities/{instance}/activities/{activity}:complete:
*?

SubscribeGlobalStatus7.yamcs.protobuf.activities.SubscribeGlobalStatusRequest/.yamcs.protobuf.activities.GlobalActivityStatus"ڒ
global-activity-status0
?

SubscribeActivities5.yamcs.protobuf.activities.SubscribeActivitiesRequest'.yamcs.protobuf.activities.ActivityInfo"ڒ

activities0
?

SubscribeActivityLog6.yamcs.protobuf.activities.SubscribeActivityLogRequest*.yamcs.protobuf.activities.ActivityLogInfo"ڒ
activity-log0
?


ListExecutors/.yamcs.protobuf.activities.ListExecutorsRequest0.yamcs.protobuf.activities.ListExecutorsResponse"*??&
$/api/activities/{instance}/executors?

ListScripts-.yamcs.protobuf.activities.ListScriptsRequest..yamcs.protobuf.activities.ListScriptsResponse"(??$
"/api/activities/{instance}/scriptsB9
org.yamcs.protobuf.activitiesBActivitiesServiceProtoP
J?A
?






"


6
	

6


7
	
7


"
	

"
	
)
	


%
	
4


?








 List activities





*

5K



?2


 Get an activity







$


/;





?2
$
" Get the activity log





*

5K

!

?2!
?
?
?
? Start an activity

 The request body allows for the execution of arbitrary activities.
 The following activity types are included in the core Yamcs module:

 .. rubric:: Command

 Execute a single command

 ``type`` (string)
     Set to ``COMMAND``.

 ``args`` (map)
     Map accepting the following options:

     ``command``
         **Required.** Qualified name of a command

     ``args`` (map)
         Named arguments, if the command requires any

     ``extra`` (map)
         Extra command options

     ``processor`` (string)
         Optional processor name. If not provided, Yamcs defaults
         to any processor it can find with commanding enabled.

 Example:

 .. code-block:: json

     {
         "type": "COMMAND",
         "args": {
             "command": "/YSS/SIMULATOR/SWITCH_VOLTAGE_ON",
             "args": {
                 "voltage_num": 3
             },
             "processor": "realtime"
         }
     }

 .. rubric:: Command Stack

 Execute a command stack

 ``type`` (string)
     Set to ``COMMAND_STACK``.

 ``args`` (map)
     Map accepting the following options:

     ``bucket``
         **Required.** The name of the bucket containg the stack

     ``stack``
         **Required.** The name of the stack object inside the bucket

     ``processor`` (string)
         Optional processor name. If not provided, Yamcs defaults
         to any processor it can find with commanding enabled.

 Example:

 .. code-block:: json

     {
         "type": "COMMAND_STACK",
         "args": {
             "bucket": "mybucket",
             "stack": "mystack.ycs",
             "processor": "realtime"
         }
     }

 .. rubric:: Script

 Run a script

 ``type`` (string)
     Set to ``SCRIPT``.
 ``args`` (map)
     Map accepting the following options:

     ``script``
         **Required.** Script identifier.

         This should be the relative path to an executable file in one of the
         search locations. When unconfigured, the default search location is
         :file:`etc/scripts/` relative to the Yamcs working directory.

     ``args`` (string or string[])
         Script arguments

     ``processor`` (string)
         If provided, this information is passed to the script in an environment
         variable ``YAMCS_PROCESSOR``.

 Example:

 .. code-block:: json

     {
         "type": "SCRIPT",
         "args": {
             "script": "simulate_los.py",
             "args": "--duration 60",
             "processor": "realtime"
         }
     }



?


?
(

?
3?

?
?


?2?
?

,
?
?
 Cancel an ongoing activity



?


?
*

?
5A

?
?


?2?
?

o
?
?
_ Mark an ongoing activity as completed.

 This method may only be used with manual activities.



?


?
:

?
EQ

?
?


?2?
?

1
?
?
! Receive activity status updates



?


?
8

?
CI

?
J^

?
?


?2?
?

*
?
?
 Receive activity updates



?


?
4

?
?E

?
FR

?
?


?2?
?

.
?
?
 Receive activity log updates



?


?
6

?
AG

?
HW

?
?


?2?
?

*
	?
?
 List available executors


	
?


	?
(

	?
3H

	?
?


	?2?
?

F

?
?
6 List scripts available for activities of type SCRIPT




?



?
$


?
/B


?
?



?2?
?


?
?




?

#
?
 Yamcs instance name


?



?



?


?

?


?
?
 The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``



?




?




?



?

h
?
Z The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``


?



?



?


?

)
?
 Filter on activity status


?



?



?


?

?
?
1 The type of activity. Names must match exactly.


?



?



?


?

H
?
: Continuation token returned by a previous page response.


?



?



?


?

?

?
/z Filter the lower bound of the activity's start time. Specify a date string
 in ISO 8601 format. This bound is inclusive.


?



?
$


?
%*

?
-.
?

?
.~ Filter the upper bound of the activity's generation time. Specify a
 datestring in ISO 8601 format. This bound is exclusive.


?



?
$


?
%)

?
,-
6
?
( Text to search for in the description.


?



?



?


?



?
?





?

#

?
 Yamcs instance name



?




?




?



?

#


?
 Activity identifier




?





?





?




?


?
?




?

#
?
 Yamcs instance name


?



?



?


?

#

?
 Activity identifier



?




?




?



?


??



?

?$
 Log entries


?


?


?

?"#

??



?
9
?'+ Resulting activities, possibly limited   


?


?


?"

?%&
?


?(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.



?



?



?#


?&'

??



?
#
? Yamcs instance name


?


?


?

?

??



?
#
?& Yamcs instance name


?


?


?!

?$%

??



?
#
? Yamcs instance name


?


?


?

?

??



?

?

?


?


?

?

	??


	
?
#
	? Yamcs instance name


	?


	?

	
?

	?
#
	
?9 Activity definition


	
?


	
?!

	

?"4

	
?78


??




?
#

? Yamcs instance name



?



?



?


?
#


? Activity identifier




?




?




?



?

??



?%
#
? Yamcs instance name


?


?


?

?
#

? Activity identifier



?



?



?


?
X
?$J Failure message, if not provided the
 activity is considered successful.


?


?


?

?"#

??



?"
#
? Yamcs instance name


?


?


?

?


??




?#
#

? Yamcs instance name



?



?



?


?
#


? Activity identifier




?




?




?



?

??



?$
#
? Yamcs instance name


?


?


?

?

??



?
0
?"" The number of ongoing activities


?


?


?

? !
?
*yamcs/protobuf/pvalue/pvalue_service.protoyamcs.protobuf.pvaluegoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/protobuf/yamcs.proto"?

LoadParameterValuesRequest
instance
 
(	Rinstance
stream 
(	RstreamC
values (2+.yamcs.protobuf.pvalue.ParameterValueUpdateRvalues"?

LoadParameterValuesResponse

valueCount
 
(
R
valueCountH
minGenerationTime 
(2.google.protobuf.TimestampRminGenerationTimeH
maxGenerationTime 
(2.google.protobuf.TimestampRmaxGenerationTime"?

ParameterValueUpdate
	parameter
 
(	R	parameter+
value 
(2.yamcs.protobuf.ValueRvalueB
generationTime 
(2.google.protobuf.TimestampRgenerationTime
	expiresIn 
(R	expiresIn2?

ParameterValuesApi?

LoadParameterValues1.yamcs.protobuf.pvalue.LoadParameterValuesRequest2.yamcs.protobuf.pvalue.LoadParameterValuesResponse"???;6/api/parameter-values/{instance}/streams/{stream}:load:
*(
B3
org.yamcs.protobufBParameterValuesServiceProtoP
J?
;









+
	

+


<
	
<


"
	

"
	
)
	


%
	
$










1
# Load a stream of parameter values





 

!;

Fa



?2


!




"
"
 Yamcs instance name














 Stream name















6
 +) A group of values, and their properties


 


 


  &

 )*



#,





##
4

%!' The number of values that were loaded



%



%



%


% 
B


(;5 The earliest generation time of all received values




(




($




(%6



(9:
@

+;3 The latest generation time of all received values



+



+$



+%6


+9:


.;




.
-
0   Fully qualified parameter name


0


0


0

0


3 The new value



3



3



3


3
i
78\ The generation time of the value. If specified, must be a date
 string in ISO 8601 format.


7


7$


7%3

767
B
: 5 How long before this value expires, in milliseconds


:


:


:

:
?Q
4yamcs/protobuf/processing/mdb_override_service.protoyamcs.protobuf.processinggoogle/protobuf/empty.protoyamcs/api/annotations.protoyamcs/protobuf/mdb/mdb.proto"V
SubscribeMdbChangesRequest
instance
 
(	Rinstance
	processor 
(	R	processor"S
ListMdbOverridesRequest
instance
 
(	Rinstance
	processor 
(	R	processor"d
ListMdbOverridesResponseH
	overrides
 (2*.yamcs.protobuf.processing.MdbOverrideInfoR	overrides"l
GetAlgorithmOverridesRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname"u
GetAlgorithmOverridesResponseT
textOverride
 
(20.yamcs.protobuf.processing.AlgorithmTextOverrideRtextOverride"k
GetParameterOverrideRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname"?
ParameterOverride
	parameter
 
(	R	parameterP
defaultCalibrator 
(2".yamcs.protobuf.mdb.CalibratorInfoRdefaultCalibratorY
contextCalibrators (2).yamcs.protobuf.mdb.ContextCalibratorInfoRcontextCalibratorsA
defaultAlarm 
(2.yamcs.protobuf.mdb.AlarmInfoRdefaultAlarmJ

contextAlarms (2$.yamcs.protobuf.mdb.ContextAlarmInfoR
contextAlarms"?
MdbOverrideInfoK
type
 
(27.yamcs.protobuf.processing.MdbOverrideInfo.OverrideTypeRtypef
algorithmTextOverride 
(20.yamcs.protobuf.processing.AlgorithmTextOverrideRalgorithmTextOverrideZ
parameterOverride 
(2,.yamcs.protobuf.processing.ParameterOverrideRparameterOverride"1
OverrideType
ALGORITHM_TEXT
	PARAMETER
"I
AlgorithmTextOverride
	algorithm
 
(	R	algorithm
text 
(	Rtext"?
UpdateParameterRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	RnameT
action 
(2<.yamcs.protobuf.processing.UpdateParameterRequest.ActionTypeRactionP
defaultCalibrator 
(2".yamcs.protobuf.mdb.CalibratorInfoRdefaultCalibratorW
contextCalibrator (2).yamcs.protobuf.mdb.ContextCalibratorInfoRcontextCalibratorA
defaultAlarm 
(2.yamcs.protobuf.mdb.AlarmInfoRdefaultAlarmH
contextAlarm (2$.yamcs.protobuf.mdb.ContextAlarmInfoRcontextAlarm"?


ActionType	
RESET
RESET_CALIBRATORS

SET_DEFAULT_CALIBRATOR
SET_CALIBRATORS
RESET_ALARMS
SET_DEFAULT_ALARMS

SET_ALARMS"?
UpdateAlgorithmRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	RnameT
action 
(2<.yamcs.protobuf.processing.UpdateAlgorithmRequest.ActionTypeRaction?
	algorithm 
(2!.yamcs.protobuf.mdb.AlgorithmInfoR	algorithm" 

ActionType	
RESET
SET
2?	
MdbOverrideApi?

ListMdbOverrides2.yamcs.protobuf.processing.ListMdbOverridesRequest3.yamcs.protobuf.processing.ListMdbOverridesResponse"C???
)/api/mdb-overrides/{instance}/{processor}jList MDB Overrides?

GetAlgorithmOverrides7.yamcs.protobuf.processing.GetAlgorithmOverridesRequest8.yamcs.protobuf.processing.GetAlgorithmOverridesResponse"B??>


	
?
. Reset calibrators to their default MDB value


	

?


	
?

R
	?
B Sets the default calibrator (the contextual ones are unmodified)


	
?


	?

?

	?
p Sets all calibrations (default + contextual), if default is not set,
 the existing calibration is not modified


	
?


	?

F
	?
6 Reset alarms to their default Mission Database value


	
?


	?

J
	?
: Sets the default alarms (contextual ones are unmodified)


	
?


	?

u
	?
e Sets all alarms (default + contextual), if default is not set, the
 existing alarm is not modified.


	
?


	?

$
	?
 Yamcs instance name.


	?



	?


	
?


	?


	
?
  Processor name.


	
?



	
?


	

?


	
?


	?
 Parameter name.


	?



	?


	
?


	?

=
	?
!/ The action by which to modify this parameter.


	?



	?


	
?


	?
 
L
	?
4> Used when action = SET_DEFAULT_CALIBRATOR or SET_CALIBRATORS


	?



	?


	
?
/

	?
23
2
	?
;$ Used when action = SET_CALIBRATORS


	?



	?
$

	
?
%6

	?
9:
C
	?
*5 Used when action = SET_DEFAULT_ALARMS or SET_ALARMS


	?



	?


	
?
%

	?
()
-
	?
1 Used when action = SET_ALARMS


	?



	?


	
?
 ,

	?
/0


?
?





?



?
?




?

6

?
& Restores the original MDB definition




?
	


?

)


?
 Sets the algorithm text





?




?


$

?
 Yamcs instance name.



?




?




?



?




?
  Processor name.




?





?





?




?



?
 Algorithm name.



?




?




?



?

<

?
!. The action by which to modify this algorithm



?




?




?



?
 
&

?
+ Used when action = SET



?




?




?
&


?
)*
??

*yamcs/protobuf/processing/processing.protoyamcs.protobuf.processinggoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/protobuf/mdb/mdb.proto"yamcs/protobuf/pvalue/pvalue.proto4yamcs/protobuf/yamcsManagement/yamcsManagement.protoyamcs/protobuf/yamcs.proto"2
ListProcessorTypesResponse
types
 (	Rtypes"3
ListProcessorsRequest
instance
 
(	Rinstance"g
ListProcessorsResponseM

processors
 (2-.yamcs.protobuf.yamcsManagement.ProcessorInfoR
processors"X
SubscribeTMStatisticsRequest
instance
 
(	Rinstance
	processor 
(	R	processor"V
SubscribeProcessorsRequest
instance
 
(	Rinstance
	processor 
(	R	processor"?
SubscribeParametersRequest
instance
 
(	Rinstance
	processor 
(	R	processor-
id (2.yamcs.protobuf.NamedObjectIdRid&
abortOnInvalid 
(RabortOnInvalid.
updateOnExpiration 
(RupdateOnExpiration$

sendFromCache 
(R
sendFromCacheT
action 
(2<.yamcs.protobuf.processing.SubscribeParametersRequest.ActionRaction
maxBytes 
(RmaxBytes"*
Action
REPLACE
ADD


REMOVE"?
SubscribeParametersDataY
mapping
 (2?.yamcs.protobuf.processing.SubscribeParametersData.MappingEntryRmappingP
info (2<.yamcs.protobuf.processing.SubscribeParametersData.InfoEntryRinfo7
invalid (2.yamcs.protobuf.NamedObjectIdRinvalid=
values (2%.yamcs.protobuf.pvalue.ParameterValueRvaluesY
MappingEntry
key
 
(
Rkey3
value 
(2.yamcs.protobuf.NamedObjectIdRvalue:8
k
	InfoEntry
key
 
(
RkeyH
value 
(22.yamcs.protobuf.processing.SubscribedParameterInfoRvalue:8
"?

SubscribedParameterInfo
	parameter
 
(	R	parameter
units 
(	RunitsB

dataSource 
(2".yamcs.protobuf.mdb.DataSourceTypeR
dataSource=

enumValues (2.yamcs.protobuf.mdb.EnumValueR
enumValues"O
GetProcessorRequest
instance
 
(	Rinstance
	processor 
(	R	processor"R
DeleteProcessorRequest
instance
 
(	Rinstance
	processor 
(	R	processor"?

CreateProcessorRequest
instance
 
(	Rinstance
name 
(	Rname

persistent 
(R
persistent
type 
(	Rtype
config 
(	Rconfig"?
EditProcessorRequest
instance
 
(	Rinstance
	processor 
(	R	processor
state 
(	Rstate.
seek 
(2.google.protobuf.TimestampRseek
speed 
(	Rspeed0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
loop 
(Rloop"?

GetParameterValueRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname
	fromCache 
(R	fromCache
timeout 
(Rtimeout"?

SetParameterValueRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname+
value 
(2.yamcs.protobuf.ValueRvalueB
generationTime 
(2.google.protobuf.TimestampRgenerationTime
	expiresIn 
(R	expiresIn"?

BatchGetParameterValuesRequest
instance 
(	Rinstance
	processor 
(	R	processor-
id
 (2.yamcs.protobuf.NamedObjectIdRid
	fromCache 
(R	fromCache
timeout 
(Rtimeout"^
BatchGetParameterValuesResponse;
value
 (2%.yamcs.protobuf.pvalue.ParameterValueRvalue"?
BatchSetParameterValuesRequest
instance 
(	Rinstance
	processor 
(	R	processorl
request
 (2R.yamcs.protobuf.processing.BatchSetParameterValuesRequest.SetParameterValueRequestRrequest?

SetParameterValueRequest-
id
 
(2.yamcs.protobuf.NamedObjectIdRid+
value 
(2.yamcs.protobuf.ValueRvalueB
generationTime 
(2.google.protobuf.TimestampRgenerationTime
	expiresIn 
(R	expiresIn"i
GetAlgorithmStatusRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname"o
SubscribeAlgorithmStatusRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname"h
GetAlgorithmTraceRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname"
EditAlgorithmTraceRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname
state 
(	Rstate"?
AlgorithmStatus
active
 
(Ractive"
traceEnabled 
(RtraceEnabled
runCount 
(
RrunCount4
lastRun 
(2.google.protobuf.TimestampRlastRun

errorCount 
(
R
errorCount"
errorMessage 
(	RerrorMessage8
	errorTime 
(2.google.protobuf.TimestampR	errorTime

execTimeNs 
(R
execTimeNs"?
AlgorithmTraceA
runs
 (2-.yamcs.protobuf.processing.AlgorithmTrace.RunRrunsA
logs (2-.yamcs.protobuf.processing.AlgorithmTrace.LogRlogs?

Run.
time
 
(2.google.protobuf.TimestampRtime=
inputs (2%.yamcs.protobuf.pvalue.ParameterValueRinputs?
outputs (2%.yamcs.protobuf.pvalue.ParameterValueRoutputs 
returnValue 
(	RreturnValue
error 
(	RerrorG
Log.
time 
(2.google.protobuf.TimestampRtime
msg 
(	Rmsg2?

ProcessingApi
ListProcessorTypes.google.protobuf.Empty5.yamcs.protobuf.processing.ListProcessorTypesResponse"??
/api/processor-types?

ListProcessors0.yamcs.protobuf.processing.ListProcessorsRequest1.yamcs.protobuf.processing.ListProcessorsResponse"??
/api/processors?

GetProcessor..yamcs.protobuf.processing.GetProcessorRequest-.yamcs.protobuf.yamcsManagement.ProcessorInfo",??(
&/api/processors/{instance}/{processor}?

DeleteProcessor1.yamcs.protobuf.processing.DeleteProcessorRequest.google.protobuf.Empty",??("&/api/processors/{instance}/{processor}?


EditProcessor/.yamcs.protobuf.processing.EditProcessorRequest.google.protobuf.Empty"/??+*&/api/processors/{instance}/{processor}:
*v
CreateProcessor1.yamcs.protobuf.processing.CreateProcessorRequest.google.protobuf.Empty"??/api/processors:
*?

GetParameterValue3.yamcs.protobuf.processing.GetParameterValueRequest%.yamcs.protobuf.pvalue.ParameterValue"???;
9/api/processors/{instance}/{processor}/parameters/{name*}?

SetParameterValue3.yamcs.protobuf.processing.SetParameterValueRequest.google.protobuf.Empty"?
???
9/api/processors/{instance}/{processor}/parameters/{name*}:valueZB9/api/processors/{instance}/{processor}/parameters/{name*}:value?

BatchGetParameterValues9.yamcs.protobuf.processing.BatchGetParameterValuesRequest:.yamcs.protobuf.processing.BatchGetParameterValuesResponse"C???:/api/processors/{instance}/{processor}/parameters:batchGet:
*?

BatchSetParameterValues9.yamcs.protobuf.processing.BatchSetParameterValuesRequest.google.protobuf.Empty"C???:/api/processors/{instance}/{processor}/parameters:batchSet:
*?

SubscribeTMStatistics7.yamcs.protobuf.processing.SubscribeTMStatisticsRequest*.yamcs.protobuf.yamcsManagement.Statistics"
ڒ	
tmstats0
?

SubscribeParameters5.yamcs.protobuf.processing.SubscribeParametersRequest2.yamcs.protobuf.processing.SubscribeParametersData"ڒ

parameters(
0
?

SubscribeProcessors5.yamcs.protobuf.processing.SubscribeProcessorsRequest-.yamcs.protobuf.yamcsManagement.ProcessorInfo"ڒ

processors0
?

GetAlgorithmStatus4.yamcs.protobuf.processing.GetAlgorithmStatusRequest*.yamcs.protobuf.processing.AlgorithmStatus"F??B
@/api/processors/{instance}/{processor}/algorithms/{name*}/status?

SubscribeAlgorithmStatus:.yamcs.protobuf.processing.SubscribeAlgorithmStatusRequest*.yamcs.protobuf.processing.AlgorithmStatus"ڒ
algorithm-status0
?

GetAlgorithmTrace3.yamcs.protobuf.processing.GetAlgorithmTraceRequest).yamcs.protobuf.processing.AlgorithmTrace"E??A
?/api/processors/{instance}/{processor}/algorithms/{name*}/trace?

EditAlgorithmTrace4.yamcs.protobuf.processing.EditAlgorithmTraceRequest.google.protobuf.Empty"H??D*?/api/processors/{instance}/{processor}/algorithms/{name*}/trace:
*B'
org.yamcs.protobufBProcessingProtoP
J??

?






"


+
	

+


0
	
0


"
	

"
	
%
	

	)
	
%
	
&
	

,
	
>
	
$

?






$
 List processor types





.

9S



?2


 List processors







*


5K





?2

"& Get a processor



"

"&

"1N

#%

?2#%
K
+/= Delete a processor

 Only replay processors can be removed.



+

+,

+7L

,.

?2,.
"
27 Update a processor



2

2(

23H

36

?236
"
:? Create a processor



:

:,

:7L

;>

?2;>
'
BF Get a parameter's value



B

B0

B;P

CE

?2CE
V
KTH Set a parameter's value

 Only some type of parameters can be updated.



K

K0

K;P

LS

?2LS
:
W\, Batch get the value of multiple parameters



W

W<

WGf

X[

?2X[
:
	_d, Batch set the value of multiple parameters


	
_

	_<

	_G\

	`c

	?2`c
-

gk Receive TM statistics updates




g


g8


gCI


gJd


hj


?2hj
?

qu?
 Receive parameter updates

 The input message can be sent multiple types, allowing to alter a
 subscription with the ``action`` field.



q

q 

q!;

qFL

qMd

rt

?2rt
)
x| Receive processor updates



x

x4

x?E

xFc

y{

?2y{
)

?
 Get the algorithm status







2


=L


?
?



?2?
?

2
?
?
" Receive algorithm status updates



?


?
>

?
IO

?
P_

?
?


?2?
?

)
?
?
 Get the algorithm trace



?


?
0

?
;I

?
?


?2?
?

2
?
?
" Enable/disable algorithm tracing



?


?
2

?
=R

?
?


?2?
?

9
?
?

+ Response message for `ListProcessorTypes`



?
"

?


?



?



?


?

5

?
?

' Request message for `ListProcessors`.




?

7

?
) Return only processors of this instance



?




?




?



?

6
?
?

( Response message for `ListProcessors`.



?


?
8

?



?
(


?
)3

?
67
<
?
?

. Request message for `SubscribeTMStatistics`.



?
$
#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?

:
?
?

, Request message for `SubscribeProcessors`.



?
"
#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?

:
?
?

, Request message for `SubscribeParameters`.



?
"
y
?
?
i Specifies what Yamcs should do with the parameter identifiers
 that are specifiedwith the ``id`` field.



?

?

?
p The parameter identifiers specified with ``id``, replace any that were
 previously subscribed to on this call.



?


?

?


?
t The parameter identifiers specified with ``id`` are added to any
 that were previously subscribed to on this call.




?



?


?

?
z The parameter identifiers specified with ``id`` are removed from those
 that were previously subscribed to on this call.



?



?


#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?

?
?
 ? 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.


?



?



?


?

Q
?
#C Send an error message if any parameter is invalid.
 Default: true


?



?



?


?
!"
?

?
'?
 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


?



?



?
"

?
%&
r
?
"d If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true


?



?



?


?
 !
?

?
 How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.


?



?



?


?

?

?
?
 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.


?



?



?


?


?
?



?

?

?
)w Mapping between numeric and subscribed identifier.
 This information is provided only once, following a subscription.


?



?
$

?
'(
?


?0?
 Mapping between numeric identifier, and matching parameter.
 This information is provided only once, following a subscription.



?&



?'+


?./
x
?%j Parameter identifiers that were subscribed to, but that
 cannot be matched against the Mission Database.


?


?


? 

?#$
-
?, Values of updated parameters.


?


? 


?!'

?*+
>
??
0 Static information for a subscribed parameter.



?
(
?  Qualified parameter name


?


?


?

?
!

? Engineering units



?



?



?


?

?-
 Data source


?


?


?(

?+,
Q
?(C Enumeration states, in case this concerns an enumerated parameter


?


?


?#

?&'
3
??
% Request message for `GetProcessor`.



?
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?
6
	??
( Request message for `DeleteProcessor`.


	
?
#
	? Yamcs instance name


	?


	?

	
?

	?

	
?  Processor name


	
?


	
?

	

?

	
?
6

??
( Request message for `CreateProcessor`.




?
=

?/ **Required.** The name of the Yamcs instance.



?



?



?


?
_


?Q **Required.** The name of the processor. Must be unique for the Yamcs instance.




?




?




?



?
D

?6 Keep the processor when terminated. Default: ``no``.



?



?



?


?
?


??
 **Required.** The type of the processor. The available values depend on how
 Yamcs Server is configured. Most Yamcs deployments support at least a type
 ``Archive`` which allows for the creation of processors replaying archived
 data.



?



?



?


?
?


??
 Configuration options specific to the processor type. Note that this should
 be a string representation of a valid JSON structure.



?



?



?


?
4
??
& Request message for `EditProcessor`.



?
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?
h
?Z The state this replay processor should be updated to. Either ``paused`` or
 ``running``.


?


?


?

?
o
?.a The time where the processing needs to jump towards. Must be a date string
 in ISO 8601 format.


?


?$


?%)

?,-
?

??
 The speed of the processor. One of:
 * ``afap``
 * a speed factor relative to the original speed. Example: ``2x``
 * a fixed delay value in milliseconds. Example: ``2000``


?


?


?

?

?/ New start time


?


?$


?%*

?-.

?. New stop time


?


?$


?%)

?,-
P
?B Continue replaying from ``start`` after having reached ``stop``.


?


?


?

?
8
??
* Request message for `GetParameterValue`.



? 
$
? Yamcs instance name.


?


?


?

?


?  Processor name



?



?



?


?

? Parameter name.


?


?


?

?
R
?D Whether the latest cached value may be returned. Default: ``yes``.


?


?


?

?
?

??
 Time in milliseconds to wait on a value (only considered if
 ``fromCache=no``). When the timeout is met, the call will return
 with no or partial data. Default: ``10000``.


?


?


?

?
8

??
* Request message for `SetParameterValue`.




? 
#

? Yamcs instance name



?



?



?


?



?  Processor name




?




?




?



?


? Parameter name



?



?



?


?


? The new value



?



?



?


?
j

?8\ The generation time of the value. If specified, must be a date
 string in ISO 8601 format.



?



?$



?%3


?67
F

? 8 How long before this value is expired, in milliseconds



?



?



?


?
>
??
0 Request message for `BatchGetParameterValues`.



?&
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?
?
? ? 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.


?


?


?

?

?

?


?


?

?
[
?M If not fromCache, wait this time (in milliseconds) to receive the parameter


?


?


?

?
?
??
1 Response message for `BatchGetParameterValues`.



?'

?+

?


? 


?!&

?)*
>
??
0 Request message for `BatchSetParameterValues`.



?&

??


?
"
?
?"?
 Parameter identifier. This 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.


?

?



?

? !


? The new value



?


?




?


?
l
?:\ The generation time of the value. If specified, must be a date
 string in ISO 8601 format.


?

?
&


?'5

?89
H
?"8 How long before this value is expired, in milliseconds


?

?



?

? !
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?
0
?0" Requests, one for each new value


?


?#


?$+

?./
9
??
+ Request message for `GetAlgorithmStatus`.



?!
$
? Yamcs instance name.


?


?


?

?


?  Processor name



?



?



?


?

? Algorithm name


?


?


?

?
?
??
1 Request message for `SubscribeAlgorithmStatus`.



?'
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?

? Algorithm name


?


?


?

?
8
??
* Request message for `GetAlgorithmTrace`.



? 
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?

? Algorithm name


?


?


?

?
9
??
+ Request message for `EditAlgorithmTrace`.



?!
#
? Yamcs instance name


?


?


?

?


?  Processor name



?



?



?


?

? Algorithm name


?


?


?

?
@
?2 Trace state: either ``enabled`` or ``disabled``.


?


?


?

?

??



?
.
? true if the algorithm is active


?


?


?

?
4

?!&true if the tracing has been enabled 



?



?



?


? 
M
?? how many times the algorithm ran (successfully or with error)


?


?


?

?
/
?1! when the algorithm was last run


?


?$


?%,

?/0
<
?!. how many times the algorithm ran with errors


?


?


?

? 
?

?#z if the algorithm produced an error, 
 the fields below contain the error message and the time when the error was raised 


?


?


?

?!"

?3

?


?$


?%.

?12
2
?!$total execution time in nanoseconds


?


?


?

? 

??



?
4
??$ A single execution of an algorithm



?

+
?0 When this run was started


?

?
&


?'+

?./
9

?.) Values of input parameters for this run



?


?
"



?#)


?,-
:
?/* Values of output parameters for this run


?

?
"


?#*

?-.
y
?$i The return value, if the algorithm returned something.
 This can be useful in the context of verifiers.


?

?



?

?"#
'
? Error message, if any


?

?



?

?
b

??R A log message that was emitted by the algorithm
 using the `Yamcs.log` function.




?



?0
 Log time



?


?
&



?'+


?./
 


? Logged message




?



?





?



?
%
? Latest algorithm runs


?


?


?

?
"

? Latest log entries



?



?



?


?
?K
*yamcs/protobuf/commanding/commanding.protoyamcs.protobuf.commandingyamcs/protobuf/yamcs.protoyamcs/protobuf/mdb/mdb.protogoogle/protobuf/timestamp.proto"?

	CommandId&
generationTime
 (RgenerationTime
origin (	Rorigin&
sequenceNumber (RsequenceNumber 
commandName 
(	RcommandName"?
CommandQueueInfo
instance
 
(	Rinstance$

processorName 
(	R
processorName
name 
(	Rname;
state 
(2%.yamcs.protobuf.commanding.QueueStateRstate
order	 
(Rorder
users
 (	Rusers
groups (	RgroupsV
minLevel 
(2:.yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelTypeRminLevel

tcPatterns
 (	R
tcPatternsF
entries (2,.yamcs.protobuf.commanding.CommandQueueEntryRentries4
acceptedCommandsCount 
(RacceptedCommandsCount4
rejectedCommandsCount 
(RrejectedCommandsCount"?
CommandQueueEntry
instance
 
(	Rinstance$

processorName 
(	R
processorName
	queueName 
(	R	queueName
id 
(	Rid
origin 
(	Rorigin&
sequenceNumber 
(RsequenceNumber 
commandName 
(	RcommandNameN
assignments (2,.yamcs.protobuf.commanding.CommandAssignmentRassignments
binary 
(Rbinary
username 
(	Rusername
comment 
(	RcommentB
generationTime 
(2.google.protobuf.TimestampRgenerationTimeF
pendingTransmissionConstraints
 
(RpendingTransmissionConstraints"?

CommandQueueEventE
type
 
(21.yamcs.protobuf.commanding.CommandQueueEvent.TypeRtype@
data 
(2,.yamcs.protobuf.commanding.CommandQueueEntryRdata"V
Type

COMMAND_ADDED

COMMAND_REJECTED
COMMAND_SENT
COMMAND_UPDATED"?

CommandQueueRequestI
	queueInfo
 
(2+.yamcs.protobuf.commanding.CommandQueueInfoR	queueInfoL

queueEntry 
(2,.yamcs.protobuf.commanding.CommandQueueEntryR
queueEntry
rebuild 
(:falseRrebuild"?

CommandSignificance&
sequenceNumber
 
(RsequenceNumberH
significance 
(2$.yamcs.protobuf.mdb.SignificanceInfoRsignificance"?

VerifierConfig
disable 
(RdisableW
checkWindow 
(25.yamcs.protobuf.commanding.VerifierConfig.CheckWindowRcheckWindowo
CheckWindow0
timeToStartChecking
 
(RtimeToStartChecking.
timeToStopChecking 
(RtimeToStopChecking"n
CommandHistoryAttribute
name
 
(	Rname+
value 
(2.yamcs.protobuf.ValueRvalue
time 
(Rtime"r
CommandAssignment
name
 
(	Rname+
value 
(2.yamcs.protobuf.ValueRvalue
	userInput 
(R	userInput"?
CommandHistoryEntry
id 
(	Rid 
commandName 
(	RcommandNameU
aliases (2;.yamcs.protobuf.commanding.CommandHistoryEntry.AliasesEntryRaliases
origin	 
(	Rorigin&
sequenceNumber
 
(RsequenceNumberB
	commandId
 
(2$.yamcs.protobuf.commanding.CommandIdR	commandIdF
attr (22.yamcs.protobuf.commanding.CommandHistoryAttributeRattrB
generationTime 
(2.google.protobuf.TimestampRgenerationTimeN
assignments (2,.yamcs.protobuf.commanding.CommandAssignmentRassignments:
AliasesEntry
key
 
(	Rkey
value 
(	Rvalue:8
*4

QueueState
BLOCKED

DISABLED
ENABLEDB
org.yamcs.protobufJ?3
?







"


+
	

+
	
$
	

&
	
)











$









"#

















=

$"0unique in relation to generationTime and origin














"#

"









 !












	


















	





N






"

 Yamcs instance name


















$ Processor name


















"#
!

 Command queue name















"

"  Current queue state



"



"



"


"
?


(?
 Submitted commands are matches to the first queue that
 whose filter criteria (if any) match the command's
 features. Queues are considered in the order specified by
 this field, going from lowest to highest.



(



(



(


(
?

1?
 This queue only considers commands that are issued
 by one of the users in this list.

 If the list is empty, all commands are considered.

 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).



1



1



1


1
?

:? This queue only considers commands that are issued
 by one of the users who belongs to any of these groups.

 If the list is empty, all commands are considered.

 Note that users/groups are considered at the same time
 (a match with any of the two is sufficient).



:



:



:


:
b

>DU This queue only considers commands that are at least
 as significant as this level.



>



>5



>6>


>AC
?


D"?
 This queue only considers commands whose qualified name
 matches any of the regular expressions in this list.

 If the list is empty, all commands are considered.



D



D



D


D!
2

	G*% Currently pending (queued) commands



	G



	G


	
G$


	G')
N


J,A Number of commands that successfully passed through this queue.




J




J




J&



J)+
C

M,6 Number of commands that were rejected by this queue.



M



M



M&


M)+
4
Qd
(One entry (command) in the command queue



Q

R

R


R


R

R


S$


S



S



S


S"#

T 

T


T


T

T

U

U


U


U

U

V

V


V


V

V

W%

W


W


W

W"$

X#

X


X


X

X "

Z.

Z


Z


Z(

Z+-

[

[


[


[

[

	\

	\


	\

	
\

	\


^


^



^



^


^

_9

_


_$


_%3

_68
?

c4s If true, the command has been accepted and is due for release
 as soon as transmission constraints are satisfied.


c


c


c.

c13


fo




f

gl


g

h


h

h


i



i


i

j


j

j

k


k

k

m

m


m


m

m


n&


n



n



n!


n$%


qu




q
 
r*" for SetQueueState


r


r


r%

r()
/

s,""for SendCommand and RejectCommand



s



s



s'


s*+
l
t+"_if rebuild is true, the binary packet will be recreated to include new time and sequence count


t


t


t

t

t*

t$)
m
x{
a this message is sent as response to validate, in case the significance is defined for a commands



x
5
y$"(the sequence number of the command sent


y


y


y

y"#


z1


z



z



z ,


z/0
i
~?

\can be used when sending commands to affect the way post transmission verifiers are running




~

?






?
+

?


?




?
&

?
)*


?
*


?



?





?
%


?
()
#
?
"disable the verifier


?



?



?


?



?
'


?




?




?
"


?
%&

?
?




?


?


?



?



?


?



?



?




?




?



?


?


?



?



?


?


?
?




?


?


?



?



?


?



?



?




?




?



?


?


?



?



?


?


	?
?



	
?


	?


	?



	?


	
?


	?


	
?
" Qualified name


	
?



	
?


	

?


	
?
 !
\
	?
#N Name aliases keyed by namespace.
 (as currently present in Mission Database)


	?


	
?


	?
 "

	?


	?



	?


	
?


	?


	?
%

	?



	?


	
?


	?
"$

	?
#

	?



	?


	
?


	?
!"

	?
,

	?



	?
"

	
?
#'

	?
*+

	?
8

	?



	?
$

	
?
%3

	?
67

	?
.

	?



	?


	
?
(

	?
+-
?
1yamcs/protobuf/commanding/clearance_service.protoyamcs.protobuf.commandinggoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/protobuf/mdb/mdb.proto"b
ListClearancesResponseH

clearances
 (2(.yamcs.protobuf.commanding.ClearanceInfoR
clearances"?

ClearanceInfo
username
 
(	RusernameP
level 
(2:.yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelTypeRlevel
issuedBy 
(	RissuedBy8
	issueTime 
(2.google.protobuf.TimestampR	issueTime2
hasCommandPrivileges 
(RhasCommandPrivileges"?

UpdateClearanceRequest
username
 
(	RusernameP
level 
(2:.yamcs.protobuf.mdb.SignificanceInfo.SignificanceLevelTypeRlevel"4
DeleteClearanceRequest
username
 
(	Rusername2?
ClearanceApir
ListClearances.google.protobuf.Empty1.yamcs.protobuf.commanding.ListClearancesResponse"??
/api/clearances?

UpdateClearance1.yamcs.protobuf.commanding.UpdateClearanceRequest(.yamcs.protobuf.commanding.ClearanceInfo"Q??M*/api/clearances/{username}:
*b,Clearance of '{username}' changed to {level}?

DeleteClearance1.yamcs.protobuf.commanding.DeleteClearanceRequest.google.protobuf.Empty"J??F"/api/clearances/{username}b(Clearance revoked from user '{username}'i
SubscribeClearance.google.protobuf.Empty(.yamcs.protobuf.commanding.ClearanceInfo"ڒ
	clearance0
B-
org.yamcs.protobufBClearanceServiceProtoP
J?

C






"


+
	

+


6
	
6


"
	

"
	
%
	

	)
	
%
	
&


.






 List clearances





*

5K



?2
)

 Update a user's clearance







,


7D





?2
)
!& Delete a user's clearance



!

!,

!7L

"%

?2"%
0
)-" Receive updates on own clearance



)

).

)9?

)@M

*,

?2*,


02




0

1(

1


1


1#

1&'



4:





4


5


5



5



5


5



6@



6




65




66;



6>?


7


7



7



7


7


83


8



8$



8%.


812


9)


9



9



9$


9'(


<?




<

=

=


=


=

=


>@


>



>5



>6;


>>?


AC




A

B

B


B


B

B
?=
.yamcs/protobuf/commanding/queues_service.protoyamcs.protobuf.commandinggoogle/protobuf/empty.protoyamcs/api/annotations.proto*yamcs/protobuf/commanding/commanding.proto"M
ListQueuesRequest
instance
 
(	Rinstance
	processor 
(	R	processor"Y
ListQueuesResponseC
queues
 (2+.yamcs.protobuf.commanding.CommandQueueInfoRqueues"[
SubscribeQueueStatisticsRequest
instance
 
(	Rinstance
	processor 
(	R	processor"W
SubscribeQueueEventsRequest
instance
 
(	Rinstance
	processor 
(	R	processor"a
GetQueueRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue"d
EnableQueueRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue"e
DisableQueueRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue"c
BlockQueueRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue"k
ListQueuedCommandsRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue"f
ListQueuedCommandsResponseH
commands
 (2,.yamcs.protobuf.commanding.CommandQueueEntryRcommands"?

AcceptCommandRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue
command 
(	Rcommand"?

RejectCommandRequest
instance
 
(	Rinstance
	processor 
(	R	processor
queue 
(	Rqueue
command 
(	Rcommand2?
	QueuesApi?


ListQueues,.yamcs.protobuf.commanding.ListQueuesRequest-.yamcs.protobuf.commanding.ListQueuesResponse"3??/
-/api/processors/{instance}/{processor}/queues?

GetQueue*.yamcs.protobuf.commanding.GetQueueRequest+.yamcs.protobuf.commanding.CommandQueueInfo";??7
5/api/processors/{instance}/{processor}/queues/{queue}?

EnableQueue-.yamcs.protobuf.commanding.EnableQueueRequest+.yamcs.protobuf.commanding.CommandQueueInfo"w??s/api/processors/{instance}/{processor}/queues/{queue}/commandsZA
=/api/processors/{instance}/{processor}/queues/{queue}/entries0
?


AcceptCommand/.yamcs.protobuf.commanding.AcceptCommandRequest.google.protobuf.Empty"U??QO/api/processors/{instance}/{processor}/queues/{queue}/commands/{command}:accept?


RejectCommand/.yamcs.protobuf.commanding.RejectCommandRequest.google.protobuf.Empty"U??QO/api/processors/{instance}/{processor}/queues/{queue}/commands/{command}:rejectB*
org.yamcs.protobufBQueuesServiceProtoP
J?"
?







"


+
	

+


3
	
3


"
	

"
	
%
	


%
	
4



[






#
 List command queues





"

-?



?2
#

 Get a command queue










)9





?2
&
# Enable a command queue





$

/?

"

?2"
'
&+ Disable a command queue



&

&&

&1A

'*

?2'*
%
.3 Block a command queue



.

."

.-=

/2

?2/2
.
6:  Receive updates on queue stats



6

6>

6IO

6P`

79

?279
/
=A! Receive updates on queue events



=

=6

=AG

=HY

>@

?2>@
$
DL List queued commands



D

D2

D=W

EK

?2EK
'
OS Accept a queued command



O

O(

O3H

PR

?2PR
'
	VZ Reject a queued command


	
V

	V(

	V3H

	WY

	?2WY


]c




]
$
_ Yamcs instance namee.


_


_


_

_


b  Processor name.



b



b



b


b



eg





e


f'


f



f



f"


f%&


io




i'
#
k Yamcs instance name.


k


k


k

k


n  Processor name.



n



n



n


n


qw




q#
#
s Yamcs instance name.


s


s


s

s


v  Processor name.



v



v



v


v

y?





y
#
{ Yamcs instance name.


{


{


{

{


~  Processor name.



~



~



~


~

?

 Queue name.


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
  Processor name.



?




?




?



?


?

 Queue name.


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
  Processor name.



?




?




?



?


?

 Queue name.


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
  Processor name.



?




?




?



?


?

 Queue name.


?



?



?


?


?
?




?
!
$
?
 Yamcs instance name.


?



?



?


?



?
  Processor name.



?




?




?



?


?

 Queue name.


?



?



?


?


	?
?



	
?
"

	?
*

	?



	?


	
?
%

	?
()


?
?





?

$

?
 Yamcs instance name.



?




?




?



?




?
  Processor name.




?





?





?




?



?

 Queue name.



?




?




?



?

#

?
 Command identifier.



?




?




?



?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
  Processor name.



?




?




?



?


?

 Queue name.


?



?



?


?

#
?
 Command identifier.


?



?



?


?

?o
0yamcs/protobuf/commanding/commands_service.protoyamcs.protobuf.commandinggoogle/protobuf/empty.protogoogle/protobuf/struct.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/api/httpbody.proto*yamcs/protobuf/commanding/commanding.protoyamcs/protobuf/yamcs.proto"?
ListCommandsRequest
instance
 
(	Rinstance
pos 
(B
Rpos
limit 
(Rlimit
order 
(	Rorder

q 
(	R
q
next 
(	Rnext0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
queue	 
(	Rqueue"?
IssueCommandRequest
instance 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname+
args 
(2.google.protobuf.StructRargs
origin 
(	Rorigin&
sequenceNumber 
(RsequenceNumber
dryRun 
(RdryRun
comment 
(	Rcomment
stream 
(	RstreamF
disableTransmissionConstraints 
(RdisableTransmissionConstraints*
disableVerifiers
 
(RdisableVerifiersj
verifierConfig (2B.yamcs.protobuf.commanding.IssueCommandRequest.VerifierConfigEntryRverifierConfigO
extra (29.yamcs.protobuf.commanding.IssueCommandRequest.ExtraEntryRextra6

Assignment
name
 
(	Rname
value 
(	Rvaluel
VerifierConfigEntry
key
 
(	Rkey?
value 
(2).yamcs.protobuf.commanding.VerifierConfigRvalue:8
O

ExtraEntry
key
 
(	Rkey+
value 
(2.yamcs.protobuf.ValueRvalue:8
"?
IssueCommandResponse
id 
(	RidB
generationTime 
(2.google.protobuf.TimestampRgenerationTime
origin 
(	Rorigin&
sequenceNumber 
(RsequenceNumber 
commandName	 
(	RcommandNameV
aliases (2<.yamcs.protobuf.commanding.IssueCommandResponse.AliasesEntryRaliasesN
assignments (2,.yamcs.protobuf.commanding.CommandAssignmentRassignments,
unprocessedBinary
 
(RunprocessedBinary
binary 
(Rbinary
username 
(	Rusername
queue
 
(	Rqueue:
AliasesEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?

UpdateCommandHistoryRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname
id 
(	RidR

attributes (22.yamcs.protobuf.commanding.CommandHistoryAttributeR
attributes"?

ListCommandsResponseH
entry
 (2..yamcs.protobuf.commanding.CommandHistoryEntryB
RentryJ
commands (2..yamcs.protobuf.commanding.CommandHistoryEntryRcommands,
continuationToken 
(	RcontinuationToken"?
GetCommandRequest
instance
 
(	Rinstance
id 
(	Rid"B
ExportCommandRequest
instance
 
(	Rinstance
id 
(	Rid"?

StreamCommandsRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
name (	Rname"?

SubscribeCommandsRequest
instance
 
(	Rinstance
	processor 
(	R	processor.
ignorePastCommands 
(RignorePastCommands"?

ExportCommandsRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
name (	Rname
	delimiter 
(	R	delimiter2?	
CommandsApi?

IssueCommand..yamcs.protobuf.commanding.IssueCommandRequest/.yamcs.protobuf.commanding.IssueCommandResponse"@??<7/api/processors/{instance}/{processor}/commands/{name*}:
*?

UpdateCommandHistory6.yamcs.protobuf.commanding.UpdateCommandHistoryRequest.google.protobuf.Empty"F??B=/api/processors/{instance}/{processor}/commandhistory/{name*}:
*?

ListCommands..yamcs.protobuf.commanding.ListCommandsRequest/.yamcs.protobuf.commanding.ListCommandsResponse"&??"
 /api/archive/{instance}/commands?


GetCommand,.yamcs.protobuf.commanding.GetCommandRequest..yamcs.protobuf.commanding.CommandHistoryEntry"+??'
%/api/archive/{instance}/commands/{id}?

StreamCommands0.yamcs.protobuf.commanding.StreamCommandsRequest..yamcs.protobuf.commanding.CommandHistoryEntry"6??2-/api/stream-archive/{instance}:streamCommands:
*0
?

SubscribeCommands3.yamcs.protobuf.commanding.SubscribeCommandsRequest..yamcs.protobuf.commanding.CommandHistoryEntry"ڒ

commands0
?


ExportCommand/.yamcs.protobuf.commanding.ExportCommandRequest.yamcs.api.HttpBody"2??.
,/api/archive/{instance}/commands/{id}:export?

ExportCommands0.yamcs.protobuf.commanding.ExportCommandsRequest.yamcs.api.HttpBody",??(
&/api/archive/{instance}:exportCommands0
B,
org.yamcs.protobufBCommandsServiceProtoP
J?M
?






"


+
	

+


5
	
5


"
	

"
	
%
	

	&
	

)
	
%
	

"
	
4
	
$


P





?

?
 Issue a command

 After validating the input parameters, the command is added to the appropriate
 command queue for further dispatch.





&

1E



?2
&

$ Update command history







6


AV


 #


?2 #

'+ List commands



'

'&

'1E

(*

?2(*

.2 Get a command



.

."

.-@

/1

?2/1
%
5: Streams back commands



5

5*

55;

5@

?2>@
$
DH Export a raw command



D

D(

D3E

EG

?2EG
-
KO Export commands in CSV format



K

K*

K5;

K
lists
 (2(.yamcs.protobuf.plists.ParameterListInfoRlists"?

CreateParameterListRequest
instance
 
(	Rinstance
name 
(	Rname 
description 
(	Rdescription
patterns (	Rpatterns"?

UpdateParameterListRequest
instance
 
(	Rinstance
list 
(	Rlist
name 
(	Rname 
description 
(	RdescriptionV
patternDefinition 
(2(.yamcs.protobuf.plists.PatternDefinitionRpatternDefinition"/
PatternDefinition
patterns
 (	Rpatterns"L
DeleteParameterListRequest
instance
 
(	Rinstance
list 
(	Rlist2?
ParameterListsApi?

ListParameterLists0.yamcs.protobuf.plists.ListParameterListsRequest1.yamcs.protobuf.plists.ListParameterListsResponse"+??'
%/api/parameter-lists/{instance}/lists?

GetParameterList..yamcs.protobuf.plists.GetParameterListRequest(.yamcs.protobuf.plists.ParameterListInfo"2??.
,/api/parameter-lists/{instance}/lists/{list}?

CreateParameterList1.yamcs.protobuf.plists.CreateParameterListRequest(.yamcs.protobuf.plists.ParameterListInfo".??*%/api/parameter-lists/{instance}/lists:
*?

UpdateParameterList1.yamcs.protobuf.plists.UpdateParameterListRequest(.yamcs.protobuf.plists.ParameterListInfo"5??1*,/api/parameter-lists/{instance}/lists/{list}:
*?

DeleteParameterList1.yamcs.protobuf.plists.DeleteParameterListRequest.google.protobuf.Empty"2??.",/api/parameter-lists/{instance}/lists/{list}B9
org.yamcs.protobuf.plistsBParameterListsServiceProtoP
J?
v









2
	

2


;
	
;


"
	

"
	
%
	


%
	
,



3






$
 List parameter lists





2

=W



?2
$

 Get a parameter list







.


9J





?2
'
# Create a parameter list





4

?P

"

?2"
'
&+ Update a parameter list



&

&4

&?P

'*

?2'*
'
.2 Delete a parameter list



.

.4

.?T

/1

?2/1


58




5!
"
7 Yamcs instance name


7


7


7

7



:@





:
"

< Yamcs instance name



<



<



<


<



? List identifier




?




?




?



?


BJ




B"
?

I'?
 List of lists, sorted by name

 The returned items include the patterns, however does
 not resolve them. Use a specific parameter list request
 to get that level of detail instead.  


I


I


I"

I%&


LX




L"
"
N Yamcs instance name


N


N


N

N


Q List name



Q



Q



Q


Q
#
T" Optional description


T


T


T

T !
C
W6 Parameter names (either exact match or glob pattern)


W


W


W

W


Zi




Z"
"
\ Yamcs instance name


\


\


\

\


_ List identifier



_



_



_


_

b List name


b


b


b

b
#
e" Optional description


e


e


e

e !
)
h3 List of parameter patterns


h


h


h.

h12


kn




k
C
m6 Parameter names (either exact match or glob pattern)


m


m


m

m


pv




p"
"
r Yamcs instance name


r


r


r

r


u List identifier



u



u



u


u
?
"yamcs/protobuf/events/events.protoyamcs.protobuf.eventsgoogle/protobuf/timestamp.proto"?
Event
source
 
(	RsourceB
generationTime 
(2.google.protobuf.TimestampRgenerationTime@

receptionTime 
(2.google.protobuf.TimestampR
receptionTime
	seqNumber 
(R	seqNumber
type 
(	Rtype
message 
(	RmessageL
severity 
(2*.yamcs.protobuf.events.Event.EventSeverity:INFORseverity
	createdBy
 
(	R	createdBy=
extra (2'.yamcs.protobuf.events.Event.ExtraEntryRextra8

ExtraEntry
key
 
(	Rkey
value 
(	Rvalue:8
"y

EventSeverity
INFO
WARNING

ERROR
	
WATCH
WARNING_NEW
DISTRESS
CRITICAL

SEVEREB#
org.yamcs.protobufBEventsProtoP
J?
<









+
	

+


,
	
,


"
	

"
	
)


<





?

.?
 The severity levels, in order are:
 INFO, WATCH, WARNING, DISTRESS, CRITICAL, SEVERE.

 A migration is underway to fully move away from the legacy
 INFO, WARNING, ERROR levels.





















#
  Legacy, avoid use.



	











	


?
)? Placeholder for future WARNING constant.
 (correctly sorted between WATCH and DISTRESS)

 Most clients can ignore, this state is here
 to give Protobuf clients (Python Client, Yamcs Studio)
 the time to add a migration for supporting both WARNING
 and WARNING_NEW (Protobuf serializes the number).

 Then in a later phase, we move from:
 WARNING=1, WARNING_NEW=4

 To:
 WARNING_OLD=1, WARNING=4

 (which is a transparent change to JSON clients)



)

)

+


+

+

,


,

,

-


-


-


/

/


/


/

/


08


0



0$



0%3


067

17

1


1$


1%2

156

2

2


2


2

2

3

3


3


3

3

4

4


4


4

4

54

5


5


5!

5$%

5%3

5.2
9
8!, Set by API when event was posted by a user


8


8


8

8 
$
;! Additional properties


;


;

; 
?`
*yamcs/protobuf/events/events_service.protoyamcs.protobuf.eventsgoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/api/httpbody.proto"yamcs/protobuf/events/events.proto"?
ListEventsRequest
instance
 
(	Rinstance
pos 
(B
Rpos
limit 
(Rlimit
order 
(	Rorder
severity 
(	Rseverity
source (	Rsource
next 
(	Rnext0
start 
(2.google.protobuf.TimestampRstart.
stop	 
(2.google.protobuf.TimestampRstop

q
 
(	R
q
filter 
(	Rfilter"?

ListEventsResponse6
event
 (2.yamcs.protobuf.events.EventB
Revent4
events (2.yamcs.protobuf.events.EventRevents,
continuationToken 
(	RcontinuationToken"L
SubscribeEventsRequest
instance
 
(	Rinstance
filter 
(	Rfilter"?
CreateEventRequest
instance
 
(	Rinstance
type 
(	Rtype
message 
(	Rmessage
severity 
(	Rseverity.
time 
(2.google.protobuf.TimestampRtime
source 
(	Rsource&
sequenceNumber 
(RsequenceNumberJ
extra (24.yamcs.protobuf.events.CreateEventRequest.ExtraEntryRextra8

ExtraEntry
key
 
(	Rkey
value 
(	Rvalue:8
"?

StreamEventsRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
source (	Rsource
severity 
(	Rseverity

q 
(	R
q
filter 
(	Rfilter"5
ListEventSourcesRequest
instance
 
(	Rinstance"P
ListEventSourcesResponse
source
 (	B
Rsource
sources (	Rsources"?
ExportEventsRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
source (	Rsource
severity 
(	Rseverity

q 
(	R
q
filter 
(	Rfilter
	delimiter 
(	R	delimiter2?
	EventsApi?


ListEvents(.yamcs.protobuf.events.ListEventsRequest).yamcs.protobuf.events.ListEventsResponse"N??J
/api/archive/{instance}/eventsZ(#/api/archive/{instance}/events:list:
*
CreateEvent).yamcs.protobuf.events.CreateEventRequest.yamcs.protobuf.events.Event"'??#/api/archive/{instance}/events:
*?

ListEventSources..yamcs.protobuf.events.ListEventSourcesRequest/.yamcs.protobuf.events.ListEventSourcesResponse",??(
&/api/archive/{instance}/events/sources?

StreamEvents*.yamcs.protobuf.events.StreamEventsRequest.yamcs.protobuf.events.Event"4??0+/api/stream-archive/{instance}:streamEvents:
*0
}
ExportEvents*.yamcs.protobuf.events.ExportEventsRequest.yamcs.api.HttpBody"*??&
$/api/archive/{instance}:exportEvents0
p
SubscribeEvents-.yamcs.protobuf.events.SubscribeEventsRequest.yamcs.protobuf.events.Event"ڒ
events(
0
B*
org.yamcs.protobufBEventsServiceProtoP
J?J
?









+
	

+


3
	
3


"
	

"
	
)
	


%
	
"
	
,


@







 List events





"

-?



?2


" Create an event







$


/4


!


?2!
"
%) List event sources



%

%.

%9Q

&(

?2&(
#
,1 Streams back events



,

,&

,17

,8=

-0

?2-0
+
48 Export events in CSV format



4

4&

417

48J

57

?257
%
;? Receive event updates



;

;

;3

;>D

;EJ

<>

?2<>

B?





B
"
D Yamcs instance name


D


D


D

D
?


K-?
 The zero-based row number at which to start outputting results.
 Default: ``0``

 This option is deprecated and will be removed in a later version.
 Use the returned continuationToken instead.



K



K



K


K


K,


K+
?

P?
 The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``


P


P


P

P
g
TZ The order of the returned results. Can be either ``asc`` or ``desc``.
 Default: ``desc``


T


T


T

T
?

X?
 The minimum severity level of the events. One of ``info``, ``watch``, ``warning``,
 ``distress``, ``critical`` or ``severe``. Default: ``info``


X


X


X

X
B
[5 The source of the events. Names must match exactly.


[


[


[

[
G
^: Continuation token returned by a previous page response.


^


^


^

^
?

b/| Filter the lower bound of the event's generation time. Specify a date string in
 ISO 8601 format. This bound is inclusive.


b


b$


b%*

b-.
?

f.| Filter the upper bound of the event's generation time. Specify a date string in
 ISO 8601 format. This bound is exclusive.


f


f$


f%)

f,-
1
	i$ Text to search for in the message.


	i


	i

	
i

	i
?

?
? Filter query. See :doc:`../filtering` for how to write a filter query.

 Literal text search matches against the fields ``message``, ``source`` and
 ``type``.

 Field comparisons can use any of the following fields:

 .. list-table::
     :widths: 25 25 50

     * - ``message``
       - string
       -
     * - ``seqNumber``
       - number
       -
     * - ``severity``
       - enum
       - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``.
     * - ``source``
       - string
       -
     * - ``type``
       - string
       -



?




?




?



?



?
?





?

2

?
-$ Deprecated, use ``events`` instead



?




?




?



?



?
,


?
+
)


?
 Page with matching events




?





?





?




?

?


?
(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.



?




?




?
#


?
&'

?
?




?

#
?
 Yamcs instance name


?



?



?


?

?

?
? Filter query. See :doc:`../filtering` for how to write a filter query.

 Literal text search matches against the fields ``message``, ``source`` and
 ``type``.

 Field comparisons can use any of the following fields:

 .. list-table::
     :widths: 25 25 50

     * - ``message``
       - string
       -
     * - ``seqNumber``
       - number
       -
     * - ``severity``
       - enum
       - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``.
     * - ``source``
       - string
       -
     * - ``type``
       - string
       -



?




?




?



?


?
?




?

#
?
 Yamcs instance name


?



?



?


?

c

?
U Description of the type of the event. Useful for quick classification or filtering.



?




?




?



?

,
?
 **Required.** Event message.


?



?



?


?

?

?
?
 The severity level of the event. One of ``info``, ``watch``, ``warning``,
 ``distress``, ``critical`` or ``severe``. Default is ``info``


?



?



?


?

o
?
.a Time associated with the event.
 If unspecified, this will default to the current mission time.


?



?
$


?
%)

?
,-
e
?
W Source of the event. Useful for grouping events in the archive. Default is
 ``User``.


?



?



?


?

?

?
$?
 Sequence number of this event. This is primarily used to determine unicity of
 events coming from the same source. If not set Yamcs will automatically
 assign a sequential number as if every submitted event is unique.


?



?



?


?
"#
%
?
  Additional properties


?



?


?


?
?



?

#
?
 Yamcs instance name


?



?



?


?

q

?
/c Filter the lower bound of the event's generation time. Specify a date
 string in ISO 8601 format.



?




?
$



?
%*


?
-.
q
?
.c Filter the upper bound of the event's generation time. Specify a date
 string in ISO 8601 format.


?



?
$


?
%)

?
,-
F
?
8 Event sources to include. Leave unset, to include all.


?



?



?


?

0
?
" Filter on minimum severity level


?



?



?


?


?
 Search by text


?



?



?


?

?
?? Filter query. See :doc:`../filtering` for how to write a filter query.

 Literal text search matches against the fields ``message``, ``source`` and
 ``type``.

 Field comparisons can use any of the following fields:

 .. list-table::
     :widths: 25 25 50

     * - ``message``
       - string
       -
     * - ``seqNumber``
       - number
       -
     * - ``severity``
       - enum
       - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``.
     * - ``source``
       - string
       -
     * - ``type``
       - string
       -


?


?


?

?

??



?
#
? Yamcs instance name


?


?


?

?

??



? 
3
?/% Deprecated, use ``sources`` instead


?


?


?

?

?.

?-
#

? Known event sources



?



?



?


?

??



?
#
? Yamcs instance name


?


?


?

?
?


?/| Filter the lower bound of the event's generation time.
 Specify a date string in ISO 8601 format. This bound is inclusive.



?



?$



?%*


?-.
?

?.| Filter the upper bound of the event's generation time. Specify a date
 string in ISO 8601 format. This bound is exclusive.


?


?$


?%)

?,-
C
?5 The source of the events. Names must match exactly.


?


?


?

?
?

??
 The minimum severity level of the events. One of ``info``, ``watch``, 
 ``warning``, ``distress`` or ``severe``. Default: ``info``


?


?


?

?
2
?$ Text to search for in the message.


?


?


?

?
?
?? Filter query. See :doc:`../filtering` for how to write a filter query.

 Literal text search matches against the fields ``message``, ``source`` and
 ``type``.

 Field comparisons can use any of the following fields:

 .. list-table::
     :widths: 25 25 50

     * - ``message``
       - string
       -
     * - ``seqNumber``
       - number
       -
     * - ``severity``
       - enum
       - One of ``info``, ``watch``, ``warning``, ``distress``, ``critical`` or ``severe``.
     * - ``source``
       - string
       -
     * - ``type``
       - string
       -


?


?


?

?
`
? R Column delimiter. One of ``TAB``, ``COMMA`` or ``SEMICOLON``.
 Default: ``TAB``.


?


?


?

?
?
$yamcs/protobuf/packets/packets.protoyamcs.protobuf.packetsgoogle/protobuf/timestamp.protoyamcs/protobuf/yamcs.proto"?
TmPacketData
packet 
(Rpacket&
sequenceNumber 
(RsequenceNumber-
id 
(2.yamcs.protobuf.NamedObjectIdRidB
generationTime	 
(2.google.protobuf.TimestampRgenerationTimeJ
earthReceptionTime
 
(2.google.protobuf.TimestampRearthReceptionTime@

receptionTime 
(2.google.protobuf.TimestampR
receptionTime
link 
(	Rlink
size 
(RsizeB$
org.yamcs.protobufBPacketsProtoP
J?
&









+
	

+


-
	
-


"
	

"
	
)
	


$



&






 
 Raw packet binary











h

$[ Storage discriminator in case of distinct packets
 with the same name and generation time














"#

 
 Packet name











,
8 When the packet was generated





$


%3

67
:
=- When the signal has been received on ground





$


%7

:<
4
7' When the packet was received by Yamcs





$


%2

56
I
"< Name of the Yamcs link where this packet was received from


"


"


"

"
#
% Packet size in bytes


%


%


%

%
?g
,yamcs/protobuf/packets/packets_service.protoyamcs.protobuf.packetsgoogle/protobuf/timestamp.protoyamcs/api/annotations.protoyamcs/api/httpbody.protoyamcs/protobuf/yamcs.protoyamcs/protobuf/mdb/mdb.proto$yamcs/protobuf/packets/packets.proto"4
ListPacketNamesRequest
instance
 
(	Rinstance"a
ListPacketNamesResponse
name
 (	B
Rname
packets (	Rpackets
links (	Rlinks"?
ListPacketsRequest
instance
 
(	Rinstance
pos 
(B
Rpos
limit 
(Rlimit
order 
(	Rorder
name (	Rname
link	 
(	Rlink
next 
(	Rnext0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop"?

ListPacketsResponse<
packet
 (2$.yamcs.protobuf.packets.TmPacketDataRpacket,
continuationToken 
(	RcontinuationToken"?

GetPacketRequest
instance
 
(	Rinstance
pname 
(	Rpname4
gentime 
(2.google.protobuf.TimestampRgentime
seqnum 
(Rseqnum"?

StreamPacketsRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
name (	Rname"?

ExtractPacketRequest
instance
 
(	Rinstance
pname 
(	Rpname4
gentime 
(2.google.protobuf.TimestampRgentime
seqnum 
(Rseqnum"?

ExtractPacketResponse

packetName
 
(	R
packetNameY
parameterValues (2/.yamcs.protobuf.packets.ExtractedParameterValueRparameterValues
messages (	Rmessages"?
ExtractedParameterValue?
	parameter
 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameterI
entryContainer 
(2!.yamcs.protobuf.mdb.ContainerInfoRentryContainer
location 
(Rlocation
size 
(Rsize1
rawValue 
(2.yamcs.protobuf.ValueRrawValue1
engValue 
(2.yamcs.protobuf.ValueRengValue"?

ExportPacketRequest
instance
 
(	Rinstance
pname 
(	Rpname4
gentime 
(2.google.protobuf.TimestampRgentime
seqnum 
(Rseqnum"?

ExportPacketsRequest
instance
 
(	Rinstance0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
name (	Rname"k
SubscribePacketsRequest
instance
 
(	Rinstance
stream 
(	Rstream
	processor 
(	R	processor"l
SubscribeContainersRequest
instance
 
(	Rinstance
	processor 
(	R	processor
names (	Rnames"?


ContainerData
name
 
(	RnameB
generationTime 
(2.google.protobuf.TimestampRgenerationTime@

receptionTime 
(2.google.protobuf.TimestampR
receptionTime
binary 
(Rbinary
seqCount 
(
RseqCount2?

PacketsApi?

ListPacketNames..yamcs.protobuf.packets.ListPacketNamesRequest/.yamcs.protobuf.packets.ListPacketNamesResponse"*??&
$/api/archive/{instance}/packet-names?

ListPackets*.yamcs.protobuf.packets.ListPacketsRequest+.yamcs.protobuf.packets.ListPacketsResponse"%??!
/api/archive/{instance}/packets?

	GetPacket(.yamcs.protobuf.packets.GetPacketRequest$.yamcs.protobuf.packets.TmPacketData"x??t
:/api/archive/{instance}/packets/{pname}/{gentime}/{seqnum}Z6
2/api/archive/{instance}/packets/{gentime}/{seqnum}0
?


ExtractPacket,.yamcs.protobuf.packets.ExtractPacketRequest-.yamcs.protobuf.packets.ExtractPacketResponse"?
???

B/api/archive/{instance}/packets/{pname}/{gentime}/{seqnum}:extractZ>
:/api/archive/{instance}/packets/{gentime}/{seqnum}:extract0
?


StreamPackets,.yamcs.protobuf.packets.StreamPacketsRequest$.yamcs.protobuf.packets.TmPacketData"5??1,/api/stream-archive/{instance}:streamPackets:
*0
?

ExportPacket+.yamcs.protobuf.packets.ExportPacketRequest.yamcs.api.HttpBody"?
???

A/api/archive/{instance}/packets/{pname}/{gentime}/{seqnum}:exportZ=
9/api/archive/{instance}/packets/{gentime}/{seqnum}:export0
?


ExportPackets,.yamcs.protobuf.packets.ExportPacketsRequest.yamcs.api.HttpBody"+??'
%/api/archive/{instance}:exportPackets0
z
SubscribePackets/.yamcs.protobuf.packets.SubscribePacketsRequest$.yamcs.protobuf.packets.TmPacketData"
ڒ	
packets0
?

SubscribeContainers2.yamcs.protobuf.packets.SubscribeContainersRequest%.yamcs.protobuf.packets.ContainerData"ڒ

containers0
B+
org.yamcs.protobufBPacketsServiceProtoP
J?F
?









+
	

+


4
	
4


"
	

"
	
)
	


%
	
"
	
$
	

&
	
.


e





!
 List packet names





,

7N



?2


 List packets







$


/B





?2

!) Get a packet



!

! 

!+7

"(

?2"(
?

08?
 Extract data from a stored packet

 This call uses the current Mission Database to perform a standalone
 extraction of a single stored packet, returning contained parameter
 values, and corresponding bit positions.



0

0(

03H

17

?217
$
;@ Streams back packets



;

;(

;39

;:F

<?

?2<?
#
CK Export a raw packet



C

C&

C1C

DJ

?2DJ
"
NR Export raw packets



N

N(

N39

N:L

OQ

?2OQ
?

Y]?
 Subscribe to packets

 This subscription is performed at stream or processor level.

 The identifier of the packets is not filled in.



Y

Y.

Y9?

Y@L

Z\

?2Z\
'
`d Subscribe to containers



`

`4

`?E

`FS

ac

?2ac


gj




g
#
i Yamcs instance name.


i


i


i

i



lu





l
"

n- Known packet names.



n



n



n


n


n,


n+
"


q Known packet names.




q




q




q



q
 

t Known link names.



t



t



t


t

w?





w
#
y Yamcs instance name.


y


y


y

y
?


?
-?
 The zero-based row number at which to start outputting results.
 Default: ``0``

 This option is deprecated and will be removed in a later version.
 Use the returned continuationToken instead.



?




?




?



?



?
,


?
+
?

?
?
 The maximum number of returned records per page. Choose this value too high
 and you risk hitting the maximum response size limit enforced by the server.
 Default: ``100``


?



?



?


?

g
?
Y The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``


?



?



?


?

K
?
= The archived name of the packets. Names must match exactly.


?



?



?


?

F
?
8 Filter by the link where the packet was received from.


?



?



?


?

H
?
: Continuation token returned by a previous page response.


?



?



?


?

?

?
/} Filter the lower bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is inclusive.


?



?
$


?
%*

?
-.
?

?
.} Filter the upper bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is exclusive.


?



?
$


?
%)

?
,-

?
?




?


?
#

?



?



?


?
!"
?


?
(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.



?




?




?
#


?
&'

?
?




?

$
?
 Yamcs instance name.


?



?



?


?

"

?
 Stored packet name



?




?




?



?

S
?
1E An exact match of the packet's generation time in
 ISO 8601 format.


?



?
$


?
%,

?
/0
4
?
& Yamcs-specific archive distinguisher


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?
/


?




?
$



?
%*


?
-.

?
.

?



?
$


?
%)

?
,-

?


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?

"

?
 Stored packet name



?




?




?



?

S
?
1E An exact match of the packet's generation time in
 ISO 8601 format.


?



?
$


?
%,

?
/0
4
?
& Yamcs-specific archive distinguisher


?



?



?


?


?
?




?


?
!
 Packet name


?



?



?


?
 
!

?
7 Contained entries



?




?
"



?
#2


?
56
;
?
- Messages generated during packet extraction


?



?



?


?

g
?
?

Y Contents of a container, can be either a parameter entry, or
 a nested container entry.



?

/
?
+! Qualified name of the parameter


?



?



?
&

?
)*
R

?
0D Qualified name of the container that defines this
 specific entry.



?




?




?
+


?
./
A
?
3 Absolute location in bits, within the full packet


?



?



?


?


?
 Bit length


?



?



?


?


?
 Raw value


?



?



?


?

!
?
 Engineering value


?



?



?


?


	?
?



	
?

$
	?
 Yamcs instance name.


	?



	?


	
?


	?

"
	
?
 Stored packet name


	
?



	
?


	

?


	
?

S
	?
1E An exact match of the packet's generation time in
 ISO 8601 format.


	?



	?
$

	
?
%,

	?
/0
4
	?
& Yamcs-specific archive distinguisher


	?



	?


	
?


	?



?
?




?

$

?
 Yamcs instance name.



?




?




?



?

?



?/} Filter the lower bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is inclusive.




?




?$




?%*



?-.
?


?.} Filter the upper bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is exclusive.



?



?$



?%)


?,-
K

?= The archived name of the packets. Names must match exactly.



?



?



?


?

??



?
$
? Yamcs instance name.


?


?


?

?
U

?G Stream name. This is mutually exclusive with the field ``processor``.



?



?



?


?
U
? G Processor name. This is mutually exclusive with the field ``stream``.


?


?


?

?

??



?"
$
? Yamcs instance name.


?


?


?

?


?  Processor name.



?



?



?


?
0
?" Container names to subscribe to.


?


?


?

?


??




?


? Container name.



?



?



?


?
G


?89 When the container's packet was generated (packet time)




?




?$




?%3



?67
B

?74 Whent the container's packet was received by Yamcs



?



?$



?%2


?56


? Container bytes



?



?



?


?
?


??
 Sequence count - it is generated by the link when the container is injected into Yamcs.
 In case this is part of a sub-container, the sequence count is the one from the encompassing container



?



?



?


?
?D
"yamcs/protobuf/alarms/alarms.protoyamcs.protobuf.alarmsgoogle/protobuf/timestamp.protoyamcs/protobuf/yamcs.protoyamcs/protobuf/mdb/mdb.proto"yamcs/protobuf/pvalue/pvalue.proto"yamcs/protobuf/events/events.proto"?

AcknowledgeInfo&
acknowledgedBy
 
(	RacknowledgedBy.
acknowledgeMessage 
(	RacknowledgeMessageD
acknowledgeTime 
(2.google.protobuf.TimestampRacknowledgeTime"?


ShelveInfo
	shelvedBy
 
(	R	shelvedBy$

shelveMessage 
(	R
shelveMessage:

shelveTime 
(2.google.protobuf.TimestampR
shelveTimeF
shelveExpiration 
(2.google.protobuf.TimestampRshelveExpiration"?

	ClearInfo
	clearedBy
 
(	R	clearedBy8
	clearTime 
(2.google.protobuf.TimestampR	clearTime"
clearMessage 
(	RclearMessage"?
	AlarmData4
type
 
(2 .yamcs.protobuf.alarms.AlarmTypeRtype<
triggerTime 
(2.google.protobuf.TimestampRtriggerTime-
id 
(2.yamcs.protobuf.NamedObjectIdRid
seqNum 
(
RseqNum@
severity 
(2$.yamcs.protobuf.alarms.AlarmSeverityRseverity

violations 
(
R
violations
count 
(
RcountP
acknowledgeInfo 
(2&.yamcs.protobuf.alarms.AcknowledgeInfoRacknowledgeInfoX
notificationType	 
(2,.yamcs.protobuf.alarms.AlarmNotificationTypeRnotificationTypeS
parameterDetail
 
(2).yamcs.protobuf.alarms.ParameterAlarmDataRparameterDetailG
eventDetail 
(2%.yamcs.protobuf.alarms.EventAlarmDataReventDetail
latching 
(Rlatching
	processOK
 
(R	processOK
	triggered 
(R	triggered"
acknowledged 
(RacknowledgedA

shelveInfo 
(2!.yamcs.protobuf.alarms.ShelveInfoR
shelveInfo>
	clearInfo 
(2 .yamcs.protobuf.alarms.ClearInfoR	clearInfo:

updateTime 
(2.google.protobuf.TimestampR
updateTime
readonly 
(Rreadonly
pending 
(Rpending"?
ParameterAlarmDataI
triggerValue
 
(2%.yamcs.protobuf.pvalue.ParameterValueRtriggerValueO
mostSevereValue 
(2%.yamcs.protobuf.pvalue.ParameterValueRmostSevereValueI
currentValue 
(2%.yamcs.protobuf.pvalue.ParameterValueRcurrentValue?
	parameter 
(2!.yamcs.protobuf.mdb.ParameterInfoR	parameter"?

EventAlarmData@
triggerEvent
 
(2.yamcs.protobuf.events.EventRtriggerEventF
mostSevereEvent 
(2.yamcs.protobuf.events.EventRmostSevereEvent@
currentEvent 
(2.yamcs.protobuf.events.EventRcurrentEvent*?

AlarmNotificationType

ACTIVE

	TRIGGERED
SEVERITY_INCREASED

VALUE_UPDATED
ACKNOWLEDGED
CLEARED
RTN
SHELVED
	UNSHELVED		
RESET

TRIGGERED_PENDING*%
	AlarmType
	PARAMETER
	
EVENT*O

AlarmSeverity	
WATCH

WARNING
DISTRESS
CRITICAL

SEVEREB#
org.yamcs.protobufBAlarmsProtoP
J?0
?










+
	

+


,
	
,


"
	

"
	
)
	


$
	
&
	
,
	

,









%







 

#$


)










$


'(

9




$


%4

78












 

















$

















"#


4






$



%/


23
`

:Swhen the shelving will expire (can be unset which means that it will never expire)







$



%5


89


#






 












 3


 



 $



 %.


 12
b
"#Uif the alarm has been manually cleared, this is the message provided by the operator


"


"


"

"!"


%2




%
=
&
"0 Initial active alarms at the moment of request



&

&
,

'" Whenever a new alarm triggers




'


'
/
("" Whenever an alarm jumps severity



(

(
\
)"O Whenever a value is updated (even if that value is not a violation by itself)



)

)
Y
*"L Whenever somebody acknowledged an alarm (it could be that it is still OOL)



*

*
X
+"K When the alarm was really cleared by the server (acknowledged && not OOL)



+	

+
?

,
"?
 When the parameter that triggered the alarm has returned to normal (the alarm may still be triggered if it has not been acknowledged)



,

,	
-
-" when the alarm has been shelved



-	

-
q
."dwhen the alarm has been unshelved (either by operator request or automatically at timer expiration)



.

.
4
	/
"'when a latching alarm has been reset  


	
/

	/

?


1"?
when an alarm first becomes active but the minimum number of violations has not been met. When that number is met, a TRIGGERED event will be sent




1


1



47





4


5



5


5



6




6



6



9?




9

:


:

:



;



;	


;

<


<


<


=


=


=


>


>

>
?
F?

? Summary of an alarm applicable for Parameter or Event (possibly
 other in the future) alarms.
 Contains detailed information on the value occurrence that initially
 triggered the alarm, the most severe value since it originally triggered,
 and the latest value at the time of your request.




F

G

G


G


G

G


H5


H



H$



H%0


H34
?
P ? For parameter alarms, this is the id of the parameters
 For event alarms
   - the id.namespace is /yamcs/event/, unless 
     EVENT_SOURCE starts with a "/" in which case the namespace
     is just the 
   - the id.name is the 


P


P


P

P
D
S7 Distinguisher between multiple alarms for the same id


S


S


S

S

U&

U


U


U!

U$%
<
X!/ Number of times the object was in alarm state


X


X


X

X 
8
[+ Number of samples received for the object


[


[


[

[

]/

]


]


]*

]-.

^6

^


^ 


^!1

^45
G
	a3: Additional detail in case the alarm is of type PARAMETER


	a


	a

	
a-

	a02
C

d+6 Additional detail in case the alarm is of type EVENT



d



d



d%


d(*
P
gC Whether the alarm will stay triggered even when the process is OK


g


g


g

g
^
jQ if the process that generated the alarm is ok (i.e. parameter is within limits)


j


j


j

j
Q

lD triggered is same with processOK except when the alarm is latching



l



l



l


l
9
n", if the operator has acknowledged the alarm


n


n


n

n!
4
q&' Details in case the alarm was shelved


q


q


q 

q#%

s$

s


s


s

s!#
3
v5& Time when the alarm was last updated


v


v$


v%/

v24
?

z~ Whether this alarm may be updated by this processor.
 Set to false when the alarms are mirrored from another Yamcs instance.


z


z


z

z
?

?
 An alarm is in pending state if the minViolations has not been reached
 The alarm is not actually triggered in this case
 This is only sent when true












?
?




?


?
2

?



?
 


?
!-

?
01


?
5


?




?
 



?
!0


?
34

?
2

?



?
 


?
!-

?
01

?
+

?



?



?
&

?
)*

?
?




?


?
)

?



?



?
$

?
'(


?
,


?




?




?
'


?
*+

?
)

?



?



?
$

?
'(
?^
*yamcs/protobuf/alarms/alarms_service.protoyamcs.protobuf.alarmsgoogle/protobuf/empty.protogoogle/protobuf/timestamp.protoyamcs/api/annotations.proto"yamcs/protobuf/alarms/alarms.proto"?

ListAlarmsRequest
instance
 
(	Rinstance
pos 
(Rpos
limit 
(Rlimit0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop
order 
(	Rorder
name 
(	Rname
next 
(	Rnext"|
ListAlarmsResponse8
alarms
 (2 .yamcs.protobuf.alarms.AlarmDataRalarms,
continuationToken 
(	RcontinuationToken"~
ListProcessorAlarmsRequest
instance
 
(	Rinstance
	processor 
(	R	processor&
includePending 
(RincludePending"W
ListProcessorAlarmsResponse8
alarms
 (2 .yamcs.protobuf.alarms.AlarmDataRalarms"z
SubscribeAlarmsRequest
instance
 
(	Rinstance
	processor 
(	R	processor&
includePending 
(RincludePending"?

EditAlarmRequest
instance
 
(	Rinstance
	processor 
(	R	processor
name 
(	Rname
seqnum 
(
Rseqnum
state 
(	Rstate
comment 
(	Rcomment&
shelveDuration 
(RshelveDuration"?

AcknowledgeAlarmRequest
instance
 
(	Rinstance
	processor 
(	R	processor
alarm 
(	Ralarm
seqnum 
(
Rseqnum
comment 
(	Rcomment"?

ShelveAlarmRequest
instance
 
(	Rinstance
	processor 
(	R	processor
alarm 
(	Ralarm
seqnum 
(
Rseqnum
comment 
(	Rcomment&
shelveDuration 
(RshelveDuration"~
UnshelveAlarmRequest
instance
 
(	Rinstance
	processor 
(	R	processor
alarm 
(	Ralarm
seqnum 
(
Rseqnum"?

ClearAlarmRequest
instance
 
(	Rinstance
	processor 
(	R	processor
alarm 
(	Ralarm
seqnum 
(
Rseqnum
comment 
(	Rcomment"X
SubscribeGlobalStatusRequest
instance
 
(	Rinstance
	processor 
(	R	processor"?
GlobalAlarmStatus0
unacknowledgedCount
 
(RunacknowledgedCount2
unacknowledgedActive 
(RunacknowledgedActive\
unacknowledgedSeverity 
(2$.yamcs.protobuf.alarms.AlarmSeverityRunacknowledgedSeverity,
acknowledgedCount 
(RacknowledgedCount.
acknowledgedActive 
(RacknowledgedActiveX
acknowledgedSeverity 
(2$.yamcs.protobuf.alarms.AlarmSeverityRacknowledgedSeverity"
shelvedCount 
(RshelvedCount$

shelvedActive 
(R
shelvedActiveN
shelvedSeverity	 
(2$.yamcs.protobuf.alarms.AlarmSeverityRshelvedSeverity2?
	AlarmsApi?


ListAlarms(.yamcs.protobuf.alarms.ListAlarmsRequest).yamcs.protobuf.alarms.ListAlarmsResponse"-??)
'/api/archive/{instance}/alarms/{name**}?

ListProcessorAlarms1.yamcs.protobuf.alarms.ListProcessorAlarmsRequest2.yamcs.protobuf.alarms.ListProcessorAlarmsResponse"3??/
-/api/processors/{instance}/{processor}/alarms?

	EditAlarm'.yamcs.protobuf.alarms.EditAlarmRequest.google.protobuf.Empty"I??E*>/api/processors/{instance}/{processor}/alarms/{name*}/{seqnum}0
:
*?

AcknowledgeAlarm..yamcs.protobuf.alarms.AcknowledgeAlarmRequest.google.protobuf.Empty"T??PK/api/processors/{instance}/{processor}/alarms/{alarm*}/{seqnum}:acknowledge:
*?

ShelveAlarm).yamcs.protobuf.alarms.ShelveAlarmRequest.google.protobuf.Empty"O??KF/api/processors/{instance}/{processor}/alarms/{alarm*}/{seqnum}:shelve:
*?


UnshelveAlarm+.yamcs.protobuf.alarms.UnshelveAlarmRequest.google.protobuf.Empty"N??JH/api/processors/{instance}/{processor}/alarms/{alarm*}/{seqnum}:unshelve?


ClearAlarm(.yamcs.protobuf.alarms.ClearAlarmRequest.google.protobuf.Empty"N??JE/api/processors/{instance}/{processor}/alarms/{alarm*}/{seqnum}:clear:
*?

SubscribeGlobalStatus3.yamcs.protobuf.alarms.SubscribeGlobalStatusRequest(.yamcs.protobuf.alarms.GlobalAlarmStatus"ڒ
global-alarm-status0
r
SubscribeAlarms-.yamcs.protobuf.alarms.SubscribeAlarmsRequest .yamcs.protobuf.alarms.AlarmData"ڒ
alarms0
B1
org.yamcs.protobuf.alarmsBAlarmsServiceProtoP
J??
?









2
	

2


3
	
3


"
	

"
	
%
	

	)
	
%
	
,


T







 List alarms





"

-?



?2



 List alarms







4


?Z





?2

 & Update an alarm



 

  

 +@

!%

?2!%
$
). Acknowledge an alarm



)

).

)9N

*-

?2*-

16 Shelve an alarm



1

1$

1/D

25

?225
!
9= Unshelve an alarm



9

9(

93H

:<

?2:<

@E Clear an alarm



@

@"

@-B

AD

?2AD
,
HL Receive alarm status updates



H

H8

HCI

HJ[

IK

?2IK
%
OS Receive alarm updates



O

O,

O7=

O>G

PR

?2PR


Vv




V
"
X Yamcs instance name


X


X


X

X
^

\Q The zero-based row number at which to start outputting results.
 Default: ``0``



\



\



\


\
?

a?
 The maximum number of returned records per page. Choose this value
 too high and you risk hitting the maximum response size limit
 enforced by the server. Default: ``100``


a


a


a

a
?

e/y Filter the lower bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is inclusive.


e


e$


e%*

e-.
?

i.y Filter the upper bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is exclusive.


i


i$


i%)

i,-
?

n?
 The order of the returned results. Can be either ``asc`` or
 ``desc``. The sorting is always by trigger time (i.e. the
 generation time of the trigger value). Default: ``desc``


n


n


n

n
]
rP Filter alarm instances on a specific alarm name (for example:
 parameter name)


r


r


r

r
G
u: Continuation token returned by a previous page response.


u


u


u

u



x





x


y 


y



y



y


y
?



~(?
 Token indicating the response is only partial. More results can then
 be obtained by performing the same request (including all original
 query parameters) and setting the ``next`` parameter to this token.




~




~




~#



~&'

?
?




?
"

?


?



?



?


?



?
 


?




?




?



?

h
?
#Z pending alarms are those for which the minimum number of violations has not been reached


?



?



?


?
!"

?
?




?
#

?
 

?



?



?


?


?
?




?


?


?



?



?


?



?
 


?




?




?



?

h
?
#Z pending alarms are those for which the minimum number of violations has not been reached


?



?



?


?
!"

?
?




?

#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?


?
 Alarm name


?



?



?


?


?


?



?



?


?

{
?
m **Required.** The state of the alarm. 
 Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.


?



?



?


?

5
?
' Message documenting the alarm change.


?



?



?


?

z
?
%lshelve time in milliseconds (if the state = shelved)
can be left out which means it is shelved indefinitely


?



?



?
 

?
#$

?
?




?

#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?


?
 Alarm name


?



?



?


?


?


?



?



?


?

5
?
' Message documenting the alarm change.


?



?



?


?


?
?




?

#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?


?
 Alarm name


?



?



?


?


?


?



?



?


?

5
?
' Message documenting the alarm change.


?



?



?


?

z
?
%lshelve time in milliseconds (if the state = shelved)
can be left out which means it is shelved indefinitely


?



?



?
 

?
#$

?
?




?

#
?
 Yamcs instance name


?



?



?


?



?
  Processor name



?




?




?



?


?
 Alarm name


?



?



?


?


?


?



?



?


?


	?
?



	
?

#
	?
 Yamcs instance name


	?



	?


	
?


	?


	
?
  Processor name


	
?



	
?


	

?


	
?


	?
 Alarm name


	?



	?


	
?


	?


	?


	?



	?


	
?


	?

4
	?
& Message documenting the alarm change


	?



	?


	
?


	?



?
?





?
$
#

?
 Yamcs instance name



?




?




?



?




?
  Processor name




?





?





?




?


?
?



?

:
?
), The number of active unacknowledged alarms


?



?



?
$

?
'(


?
)q True if there is at least one unacknowledged alarm not OK
 (i.e. latest value of parameter still out of limits)



?




?




?
$


?
'(
@
?
42 Highest severity among all unacknowledged alarms


?



?



?
/

?
23
8
?'* The number of active acknowledged alarms


?


?


?"

?%&
}
?'o True if there is at least one acknowledged alarm not OK
 (i.e. latest value of parameter still out of limits)


?


?


?"

?%&
>
?20 Highest severity among all acknowledged alarms


?


?


?-

?01
,
?" The number of shelved alarms


?


?


?

? !
w
?"i True if there is at least one shelved alarm not OK (i.e. latest value of parameter still out of limits)


?


?


?

? !
9
?-+ Highest severity among all shelved alarms


?


?


?(

?+,
?

 yamcs/protobuf/table/table.protoyamcs.protobuf.tableyamcs/api/annotations.protoyamcs/protobuf/yamcs.proto4yamcs/protobuf/yamcsManagement/yamcsManagement.protogoogle/protobuf/timestamp.proto"?
Row>
columns
 (2$.yamcs.protobuf.table.Row.ColumnInfoRcolumns4
cells (2.yamcs.protobuf.table.Row.CellRcellsd

ColumnInfo
id
 
(
Rid
name 
(	Rname
type 
(	Rtype

protoClass 
(	R
protoClass6
Cell
columnId
 
(
RcolumnId
data 
(Rdata"m
ReadRowsRequest
instance
 
(	Rinstance
table 
(	Rtable
cols (	Rcols
query 
(	Rquery"q
WriteRowsRequest
instance
 
(	Rinstance
table 
(	Rtable+
row 
(2.yamcs.protobuf.table.RowRrow")
WriteRowsResponse
count
 
(
Rcount"0
WriteRowsExceptionDetail
count
 
(
Rcount":
	ListValue-
values
 (2.yamcs.protobuf.ValueRvalues"M
ExecuteSqlRequest
instance
 
(	Rinstance
	statement 
(	R	statement"|
	ResultSet:
columns
 (2 .yamcs.protobuf.table.ColumnInfoRcolumns3
rows (2.yamcs.protobuf.table.ListValueRrows"/
ListTablesRequest
instance
 
(	Rinstance"M
ListTablesResponse7
tables
 (2.yamcs.protobuf.table.TableInfoRtables"A
GetTableRequest
instance
 
(	Rinstance
name 
(	Rname"?

GetTableDataRequest
instance
 
(	Rinstance
name 
(	Rname
cols (	Rcols
pos 
(Rpos
limit 
(Rlimit
order 
(	Rorder"0
ListStreamsRequest
instance
 
(	Rinstance"Q
ListStreamsResponse:
streams
 (2 .yamcs.protobuf.table.StreamInfoRstreams"B
GetStreamRequest
instance
 
(	Rinstance
name 
(	Rname"L
SubscribeStreamRequest
instance
 
(	Rinstance
stream 
(	Rstream"M

ColumnData
name
 
(	Rname+
value 
(2.yamcs.protobuf.ValueRvalue"^

StreamData
stream
 
(	Rstream8
column (2 .yamcs.protobuf.table.ColumnDataRcolumn">
 SubscribeStreamStatisticsRequest
instance
 
(	Rinstance"?

	TableDataC
record
 (2+.yamcs.protobuf.table.TableData.TableRecordRrecordG
TableRecord8
column
 (2 .yamcs.protobuf.table.ColumnDataRcolumn"?


ColumnInfo
name
 
(	Rname
type 
(	Rtype=
	enumValue (2.yamcs.protobuf.table.EnumValueR	enumValue$

autoIncrement 
(R
autoIncrement"7
	EnumValue
value
 
(Rvalue
label 
(	Rlabel"?
	TableInfo
name
 
(	Rname>
	keyColumn (2 .yamcs.protobuf.table.ColumnInfoR	keyColumnB
valueColumn (2 .yamcs.protobuf.table.ColumnInfoRvalueColumn
script 
(	Rscript(
histogramColumn (	RhistogramColumn$

storageEngine 
(	R
storageEngine$

formatVersion 
(R
formatVersion

tablespace 
(	R
tablespace

compressed	 
(R
compressedR
partitioningInfo
 
(2&.yamcs.protobuf.table.PartitioningInfoRpartitioningInfo"?
PartitioningInfoK
type
 
(27.yamcs.protobuf.table.PartitioningInfo.PartitioningTypeRtype

timeColumn 
(	R
timeColumn0
timePartitionSchema 
(	RtimePartitionSchema 
valueColumn 
(	RvalueColumn(
valueColumnType 
(	RvalueColumnType";
PartitioningType
TIME
	
VALUE
TIME_AND_VALUE"?


StreamInfo
name
 
(	Rname<
column (2 .yamcs.protobuf.table.ColumnInfoB
Rcolumn:
columns (2 .yamcs.protobuf.table.ColumnInfoRcolumns
script 
(	Rscript
	dataCount 
(R	dataCount 
subscribers (	Rsubscribers"?

RebuildHistogramRequest
instance
 
(	Rinstance
table 
(	Rtable0
start 
(2.google.protobuf.TimestampRstart.
stop 
(2.google.protobuf.TimestampRstop"
RebuildHistogramResponse2?
TableApi?


ExecuteSql'.yamcs.protobuf.table.ExecuteSqlRequest.yamcs.protobuf.table.ResultSet"8??4"/api/archive/{instance}:executeSql:
*jExecute SQL?

ExecuteStreamingSql'.yamcs.protobuf.table.ExecuteSqlRequest.yamcs.protobuf.table.ResultSet"K??G+/api/archive/{instance}:executeStreamingSql:
*jExecute Streaming SQL0
?

ListStreams(.yamcs.protobuf.table.ListStreamsRequest).yamcs.protobuf.table.ListStreamsResponse"%??!
/api/archive/{instance}/streams?

SubscribeStreamStatistics6.yamcs.protobuf.table.SubscribeStreamStatisticsRequest+.yamcs.protobuf.yamcsManagement.StreamEvent"ڒ
stream-stats0
?

	GetStream&.yamcs.protobuf.table.GetStreamRequest .yamcs.protobuf.table.StreamInfo",??(
&/api/archive/{instance}/streams/{name}q
SubscribeStream,.yamcs.protobuf.table.SubscribeStreamRequest .yamcs.protobuf.table.StreamData"ڒ
stream0
?


ListTables'.yamcs.protobuf.table.ListTablesRequest(.yamcs.protobuf.table.ListTablesResponse"$?? 
/api/archive/{instance}/tables
GetTable%.yamcs.protobuf.table.GetTableRequest.yamcs.protobuf.table.TableInfo"+??'
%/api/archive/{instance}/tables/{name}?

GetTableData).yamcs.protobuf.table.GetTableDataRequest.yamcs.protobuf.table.TableData"0??,
*/api/archive/{instance}/tables/{name}/data?

ReadRows%.yamcs.protobuf.table.ReadRowsRequest.yamcs.protobuf.table.Row"8??4//api/archive/{instance}/tables/{table}:readRows:
*0
?

	WriteRows&.yamcs.protobuf.table.WriteRowsRequest'.yamcs.protobuf.table.WriteRowsResponse";??70/api/archive/{instance}/tables/{table}:writeRows:row(
?

RebuildHistogram-.yamcs.protobuf.table.RebuildHistogramRequest..yamcs.protobuf.table.RebuildHistogramResponse"@??<7/api/archive/{instance}/tables/{table}:rebuildHistogram:
*B
org.yamcs.protobufJ?c
?







	
%
	

$
	
>
	
)


	+
	

	+
J
?

= Service for reading and writing to Yamcs tables and streams







 Execute SQL





"

-6



?2
%

 Execute streaming SQL







+


6<


=F





?2
?

$(v List streams

 Note that this will only list the fixed columns of the stream.
 Tuples may always have extra columns.



$

$$

$/B

%'

?2%'
/
+/! Receive updates on stream stats



+

+ @

+KQ

+Rm

,.

?2,.

26 Get a stream



2

2 

2+5

35

?235
&
9= Receive stream updates



9

9,

97=

9>H

:<

?2:<
?

CGv List tables

 The response will only include fixed columns of the table. Tuples may always
 add extra value columns.



C

C"

C-?

DF

?2DF

JN
 Get a table



J

J

J)2

KM

?2KM

QU Get table data



Q

Q&

Q1:

RT

?2RT
?
	`e? Streams back the contents of all rows in key order

 The ``ColumnInfo`` message assigns an integer ``id`` for each column
 and the ``id`` is present in each cell belonging to that column (this
 is done in order to avoid sending the ``ColumnInfo`` with each ``Cell``).
 The column id starts from 0 and are incremented with each new column found.
 The ids are only valid during one single dump.
 The dumped data does not contain information on any table characteristics
 such as (primary) key, partitioning or other storage options.


	
`

	`

	`)/

	`03

	ad

	?2ad
?

?
?
? Imports a stream of rows

 The table has to exist in order to load data into it.

 As soon as the server detects an error with one of the written
 rows, it will forcefully close the connection and send back an
 early error message. The client should stop streaming and handle
 the error.

 Note that the erratic condition causes the connection to be closed
 even if the ``Keep-Alive`` request header was enabled.

 The error response is of type ``ExceptionMessage`` and contains a
 detail message of type ``WriteRowsExceptionDetail`` that provides
 the number of rows that were successfully written by the client.
 The client can use this information to link the error message to a
 row (i.e. the bad row is at position ``count + 1`` of the stream).

 One possible error could be that the table has defined a (primary)
 key and one of the loaded rows contains no value for one of the
 columns of the key.

 The table load will overwrite any data existing in the table with the 
 same key as the imported row.

 The table load will not update the histograms so a histogram rebuild
 is required after the load.  




?



?



?
'


?
2C


?
?



?2?
?

?
?
?
? Rebuilds histograms - this is required after a table load.

 Currently the time interval passed in the request will be used to select the
 partitions which will be rebuild - any partition overlapping with the interval will be rebuilt.
 If the table is not partitioned by time,  the histogram for the entire table will be rebuild.



?


?
.

?
9Q

?
?


?2?
?


?
?




?


?
?



?



?


?


?




?


?



?



?



?





?



?


?


?


?




?


?

]
?
#M The name of the class implementing the proto object if dataType is PROTOBUF


?


?




?


?
!"


?
?




?




?
!


?



?





?



?
 



?




?




?






?




?

Z
?
"Lthe column info is only present for new columns in a stream of Row messages


?



?



?


?
 !


?



?




?




?



?



?
?





?

$

?
 Yamcs instance name.



?




?




?



?




?

 Table name.




?





?





?




?

?


?
x The columns to be included in the result. If unspecified, all
 table and/or additional tuple columns will be included.



?




?




?



?

?


?
?
 Limit the results by specifying a SQL WHERE clause.

 Examples:
 - pname = '/YSS/SIMULATOR/FlightData'
 - gentime > '2023-01-01T00:00:00.000Z'
 - pname = '/YSS/SIMULATOR/FlightData' and gentime > '2023-01-01T00:00:00.000Z'



?




?




?



?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?



?

 Table name.



?




?




?



?


?


?



?



?


?


?
?




?

4
?
& The number of rows that were written


?



?



?


?


?
?




?
 

?


?



?



?


?


?
?




?


?


?



?



?


?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?

#

?
  StreamSQL statement



?




?




?



?


?
?




?


?
"

?



?



?


?
 !


?



?




?




?



?


?
?




?

$
?
 Yamcs instance name.


?



?



?


?


	?
?



	
?


	?
 

	?



	?


	
?


	?



?
?





?

$

?
 Yamcs instance name.



?




?




?



?




?

 Table name.




?





?





?




?


?
?



?

$
?
 Yamcs instance name.


?



?



?


?



?

 Table name.



?




?




?



?

?

?
x The columns to be included in the result. If unspecified, all table
 and/or additional tuple columns will be included.


?



?



?


?

?
?? The zero-based row number at which to start outputting results. Default: ``0``
 Note that in the current rocksdb storage engine there is no way to jump to a row by its number. 
 This is why such a request will do a table scan and can be slow for large values of pos.


?


?


?

?
?

??
 The maximum number of returned records per page. Choose this value
 too high and you risk hitting the maximum response size limit
 enforced by the server. Default: ``100``


?


?


?

?
?

??
 The direction of the sort. Sorting is always done on the key of the
 table. Can be either ``asc`` or ``desc``. Default: ``desc``


?


?


?

?

??



?
$
? Yamcs instance name.


?


?


?

?


??




?


?"


?



?



?


? !

??



?
#
? Yamcs instance name


?


?


?

?


?
 Stream name



?



?



?


?

??



?
#
? Yamcs instance name


?


?


?

?


?
 Stream name



?



?



?


?

??



?

?

?


?


?

?


?


?



?



?


?

??



?

?

?


?


?

?


?!


?



?



?


? 

??



?(

?

?


?


?

?

??



?

??


?


?#

?

?



?

?!"

?"

?


?


?

? !

??



?

? Colum name


?


?


?

?


?
 Column type



?



?



?


?

?#

?


?


?

?!"
v
?"h Attribute indicating automatic auto increment upon
 record insertion. Only set for table column info. 


?


?


?

? !

??



?

?

?


?


?

?


?


?



?



?


?

??



?

? Table name


?


?


?

?


?$


?



?



?


?"#

?&

?


?


?!

?$%

?

?


?


?

?

?&

?


?


?!

?$%

?$

?


?


?

?"#

?#

?


?


?

?!"

?!

?


?


?

? 

?

?


?


?

?

	?2

	?


	?

	
?,

	?/1

??



?

??


?

?


?

?


?



?	


?

?


?

?

?%

?


?


? 

?#$


?!


?



?



?


? 

?*

?


?


?%

?()

?"

?


?


?

? !

?&

?


?


?!

?$%

??



?

?
 Stream name


?


?


?

?


?3


?



?



?


? 


?!2


?"1

?"

?


?


?

? !

?

?


?


?

?

?

?


?


?

?
M
?"? Subscribers represented in the format ``className@hashCode``.


?


?


?

? !

??



?
$
? Yamcs instance name.


?


?


?

?


?
 Table name.



?



?



?


?
?

?/?
 Specify a date string in ISO 8601 format. The histogram data for all
 partitions overlapping with the [start, stop] interval will be
 recreated.
 If not specified, it is assumed as the start of the archive.


?


?$


?%*

?-.
?

?.?
 Specify a date string in ISO 8601 format. The histogram data for all
 partitions overlapping with the [start, stop] interval will be
 recreated.
 If not specified, it is assumed as the end of of the archive.


?


?$


?%)

?,-

??



?