api

type CancelOptions struct {
	Call int32 `protobuf:"varint,1,opt,name=call,proto3" json:"call,omitempty"`
	// contains filtered or unexported fields
}

type ClientMessage struct {

	// Message type. Typically the name of a topic to subscribe to, or a built-in like "cancel".
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// Options specific to the type
	Options *any1.Any `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// Optional client-side message identifier, returned in reply messages.
	Id int32 `protobuf:"varint,3,opt,name=id,proto3" json:"id,omitempty"`
	// If applicable, the call associated with this message
	// This should be used when the client is streaming multiple messages
	// handled by the same call.
	Call int32 `protobuf:"varint,4,opt,name=call,proto3" json:"call,omitempty"`
	// 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.
	//
	// Deprecated: Do not use.
	MaxDroppedWrites int32 `protobuf:"varint,5,opt,name=maxDroppedWrites,proto3" json:"maxDroppedWrites,omitempty"`
	// 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.
	LowPriority bool `protobuf:"varint,6,opt,name=lowPriority,proto3" json:"lowPriority,omitempty"`
	// contains filtered or unexported fields
}

type ExceptionMessage struct {
	Code   int32     `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Type   string    `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Msg    string    `protobuf:"bytes,3,opt,name=msg,proto3" json:"msg,omitempty"`
	Detail *any1.Any `protobuf:"bytes,4,opt,name=detail,proto3" json:"detail,omitempty"`
	// contains filtered or unexported fields
}

type FieldBehavior int32

type HttpBody struct {

	// The Content-Type header value for this body.
	// If unspecified, defaults to application/octet-stream
	ContentType *string `protobuf:"bytes,1,opt,name=content_type,json=contentType" json:"content_type,omitempty"`
	// If set, a Content-Disposition header is added
	// to the response. Weg agents use this to trigger
	// a download.
	Filename *string `protobuf:"bytes,2,opt,name=filename" json:"filename,omitempty"`
	// The body as raw binary
	Data []byte `protobuf:"bytes,3,opt,name=data" json:"data,omitempty"`
	// Any other metadata (used in multipart/form)
	Metadata map[string]string `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

type HttpRoute struct {

	// Types that are assignable to Pattern:
	//
	//	*HttpRoute_Get
	//	*HttpRoute_Put
	//	*HttpRoute_Post
	//	*HttpRoute_Delete
	//	*HttpRoute_Patch
	Pattern    isHttpRoute_Pattern `protobuf_oneof:"pattern"`
	Deprecated *bool               `protobuf:"varint,6,opt,name=deprecated" json:"deprecated,omitempty"`
	// Name of the field in the request message that maps to the request body
	// The special value "*" indicates that the request message as a whole
	// represents the body (excepting route params).
	Body        *string `protobuf:"bytes,7,opt,name=body" json:"body,omitempty"`
	MaxBodySize *int32  `protobuf:"varint,8,opt,name=max_body_size,json=maxBodySize" json:"max_body_size,omitempty"`
	// Set true if the execution of the route is expected to take a long time
	// (more than 0.5 seconds). It will be offloaded to a worker thread.
	// Leave false if the route uses its own threading mechanism (most of the
	// routes should do that).
	Offloaded *bool `protobuf:"varint,9,opt,name=offloaded" json:"offloaded,omitempty"`
	// Name of the field in the response message where a user-specified field
	// mask is applied to. If this indicates a repeated field, the field mask
	// is applied to each of those messages.
	// If unspecified, Yamcs will try to derive this itself.
	FieldMaskRoot      *string      `protobuf:"bytes,10,opt,name=field_mask_root,json=fieldMaskRoot" json:"field_mask_root,omitempty"`
	AdditionalBindings []*HttpRoute `protobuf:"bytes,11,rep,name=additional_bindings,json=additionalBindings" json:"additional_bindings,omitempty"`
	// Human-friendly log message format.
	Log *string `protobuf:"bytes,12,opt,name=log" json:"log,omitempty"`
	// contains filtered or unexported fields
}

type HttpRoute_Delete struct {
	// Maps to HTTP DELETE. Used for deleting a resource.
	Delete string `protobuf:"bytes,4,opt,name=delete,oneof"`
}

type HttpRoute_Get struct {
	// Maps to HTTP GET. Used for listing and getting information about
	// resources.
	Get string `protobuf:"bytes,1,opt,name=get,oneof"`
}

type HttpRoute_Patch struct {
	// Maps to HTTP PATCH. Used for updating a resource.
	Patch string `protobuf:"bytes,5,opt,name=patch,oneof"`
}

type HttpRoute_Post struct {
	// Maps to HTTP POST. Used for creating a resource or performing an action.
	Post string `protobuf:"bytes,3,opt,name=post,oneof"`
}

type HttpRoute_Put struct {
	// Maps to HTTP PUT. Used for replacing a resource.
	Put string `protobuf:"bytes,2,opt,name=put,oneof"`
}

type Reply struct {

	// The id of the original client message (if provided)
	ReplyTo int32 `protobuf:"varint,1,opt,name=reply_to,json=replyTo,proto3" json:"reply_to,omitempty"`
	// If set, the call was not successful.
	Exception *ExceptionMessage `protobuf:"bytes,2,opt,name=exception,proto3" json:"exception,omitempty"`
	// contains filtered or unexported fields
}

type ServerMessage struct {

	// Message type. Typically the name of the subscribed topic, or a built-in like "reply".
	Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`
	// If applicable, the call associated with this message
	Call int32 `protobuf:"varint,2,opt,name=call,proto3" json:"call,omitempty"`
	// Sequence counter (scoped to the call)
	Seq  int32     `protobuf:"varint,3,opt,name=seq,proto3" json:"seq,omitempty"`
	Data *any1.Any `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

type State struct {
	Calls []*State_CallInfo `protobuf:"bytes,1,rep,name=calls,proto3" json:"calls,omitempty"`
	// contains filtered or unexported fields
}

type State_CallInfo struct {
	Call    int32     `protobuf:"varint,1,opt,name=call,proto3" json:"call,omitempty"`
	Type    string    `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
	Options *any1.Any `protobuf:"bytes,3,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

type WebSocketTopic struct {
	Topic              *string           `protobuf:"bytes,1,opt,name=topic" json:"topic,omitempty"`
	Deprecated         *bool             `protobuf:"varint,2,opt,name=deprecated" json:"deprecated,omitempty"`
	AdditionalBindings []*WebSocketTopic `protobuf:"bytes,3,rep,name=additional_bindings,json=additionalBindings" json:"additional_bindings,omitempty"`
	// contains filtered or unexported fields
}