api

package
v0.0.0-...-6850833 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 18, 2024 License: LGPL-3.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	FieldBehavior_name = map[int32]string{
		0: "FIELD_BEHAVIOR_UNSPECIFIED",
		1: "SECRET",
	}
	FieldBehavior_value = map[string]int32{
		"FIELD_BEHAVIOR_UNSPECIFIED": 0,
		"SECRET":                     1,
	}
)

Enum value maps for FieldBehavior.

View Source 
var (
	// optional yamcs.api.HttpRoute route = 6433;
	E_Route = &file_yamcs_api_annotations_proto_extTypes[1]
	// optional yamcs.api.WebSocketTopic websocket = 6443;
	E_Websocket = &file_yamcs_api_annotations_proto_extTypes[2]
)

Extension fields to descriptor.MethodOptions.

View Source 
var (
	// repeated yamcs.api.FieldBehavior field_behavior = 6533;
	E_FieldBehavior = &file_yamcs_api_annotations_proto_extTypes[3]
)

Extension fields to descriptor.FieldOptions.

View Source 
var (
	// Short, human-friendly label describing this service.
	// This is a hint to programs that process proto
	// definitions, such as for document generation.
	//
	// Example:
	//
	//	service MdbApi {
	//	  option (yamcs.api.label) = "MDB";
	//	}
	//
	// optional string label = 2048;
	E_Label = &file_yamcs_api_annotations_proto_extTypes[0]
)

Extension fields to descriptor.ServiceOptions.

View Source 
var File_yamcs_api_annotations_proto protoreflect.FileDescriptor
View Source 
var File_yamcs_api_exception_proto protoreflect.FileDescriptor
View Source 
var File_yamcs_api_httpbody_proto protoreflect.FileDescriptor
View Source 
var File_yamcs_api_websocket_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CancelOptions 

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

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

func (*CancelOptions) Descriptor deprecated 

func (*CancelOptions) Descriptor() ([]byte, []int)

Deprecated: Use CancelOptions.ProtoReflect.Descriptor instead.

func (*CancelOptions) GetCall 

func (x *CancelOptions) GetCall() int32

func (*CancelOptions) ProtoMessage 

func (*CancelOptions) ProtoMessage()

func (*CancelOptions) ProtoReflect 

func (x *CancelOptions) ProtoReflect() protoreflect.Message

func (*CancelOptions) Reset 

func (x *CancelOptions) Reset()

func (*CancelOptions) String 

func (x *CancelOptions) String() string

type ClientMessage 

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
}

func (*ClientMessage) Descriptor deprecated 

func (*ClientMessage) Descriptor() ([]byte, []int)

Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.

func (*ClientMessage) GetCall 

func (x *ClientMessage) GetCall() int32

func (*ClientMessage) GetId 

func (x *ClientMessage) GetId() int32

func (*ClientMessage) GetLowPriority 

func (x *ClientMessage) GetLowPriority() bool

func (*ClientMessage) GetMaxDroppedWrites deprecated 

func (x *ClientMessage) GetMaxDroppedWrites() int32

Deprecated: Do not use.

func (*ClientMessage) GetOptions 

func (x *ClientMessage) GetOptions() *any1.Any

func (*ClientMessage) GetType 

func (x *ClientMessage) GetType() string

func (*ClientMessage) ProtoMessage 

func (*ClientMessage) ProtoMessage()

func (*ClientMessage) ProtoReflect 

func (x *ClientMessage) ProtoReflect() protoreflect.Message

func (*ClientMessage) Reset 

func (x *ClientMessage) Reset()

func (*ClientMessage) String 

func (x *ClientMessage) String() string

type ExceptionMessage 

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
}

Generic holder for an exception

func (*ExceptionMessage) Descriptor deprecated 

func (*ExceptionMessage) Descriptor() ([]byte, []int)

Deprecated: Use ExceptionMessage.ProtoReflect.Descriptor instead.

func (*ExceptionMessage) GetCode 

func (x *ExceptionMessage) GetCode() int32

func (*ExceptionMessage) GetDetail 

func (x *ExceptionMessage) GetDetail() *any1.Any

func (*ExceptionMessage) GetMsg 

func (x *ExceptionMessage) GetMsg() string

func (*ExceptionMessage) GetType 

func (x *ExceptionMessage) GetType() string

func (*ExceptionMessage) ProtoMessage 

func (*ExceptionMessage) ProtoMessage()

func (*ExceptionMessage) ProtoReflect 

func (x *ExceptionMessage) ProtoReflect() protoreflect.Message

func (*ExceptionMessage) Reset 

func (x *ExceptionMessage) Reset()

func (*ExceptionMessage) String 

func (x *ExceptionMessage) String() string

type FieldBehavior 

type FieldBehavior int32
const (
	// Default. Do not use.
	FieldBehavior_FIELD_BEHAVIOR_UNSPECIFIED FieldBehavior = 0
	// Marks a field as secret. Services, such as audit logging, may use
	// this as a hint for masking or hiding this field.
	FieldBehavior_SECRET FieldBehavior = 1
)

func (FieldBehavior) Descriptor 

func (FieldBehavior) Descriptor() protoreflect.EnumDescriptor

func (FieldBehavior) Enum 

func (x FieldBehavior) Enum() *FieldBehavior

func (FieldBehavior) EnumDescriptor deprecated 

func (FieldBehavior) EnumDescriptor() ([]byte, []int)

Deprecated: Use FieldBehavior.Descriptor instead.

func (FieldBehavior) Number 

func (x FieldBehavior) Number() protoreflect.EnumNumber

func (FieldBehavior) String 

func (x FieldBehavior) String() string

func (FieldBehavior) Type 

func (FieldBehavior) Type() protoreflect.EnumType

func (*FieldBehavior) UnmarshalJSON deprecated 

func (x *FieldBehavior) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type HttpBody 

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
}

func (*HttpBody) Descriptor deprecated 

func (*HttpBody) Descriptor() ([]byte, []int)

Deprecated: Use HttpBody.ProtoReflect.Descriptor instead.

func (*HttpBody) GetContentType 

func (x *HttpBody) GetContentType() string

func (*HttpBody) GetData 

func (x *HttpBody) GetData() []byte

func (*HttpBody) GetFilename 

func (x *HttpBody) GetFilename() string

func (*HttpBody) GetMetadata 

func (x *HttpBody) GetMetadata() map[string]string

func (*HttpBody) ProtoMessage 

func (*HttpBody) ProtoMessage()

func (*HttpBody) ProtoReflect 

func (x *HttpBody) ProtoReflect() protoreflect.Message

func (*HttpBody) Reset 

func (x *HttpBody) Reset()

func (*HttpBody) String 

func (x *HttpBody) String() string

type HttpRoute 

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
}

func (*HttpRoute) Descriptor deprecated 

func (*HttpRoute) Descriptor() ([]byte, []int)

Deprecated: Use HttpRoute.ProtoReflect.Descriptor instead.

func (*HttpRoute) GetAdditionalBindings 

func (x *HttpRoute) GetAdditionalBindings() []*HttpRoute

func (*HttpRoute) GetBody 

func (x *HttpRoute) GetBody() string

func (*HttpRoute) GetDelete 

func (x *HttpRoute) GetDelete() string

func (*HttpRoute) GetDeprecated 

func (x *HttpRoute) GetDeprecated() bool

func (*HttpRoute) GetFieldMaskRoot 

func (x *HttpRoute) GetFieldMaskRoot() string

func (*HttpRoute) GetGet 

func (x *HttpRoute) GetGet() string

func (*HttpRoute) GetLog 

func (x *HttpRoute) GetLog() string

func (*HttpRoute) GetMaxBodySize 

func (x *HttpRoute) GetMaxBodySize() int32

func (*HttpRoute) GetOffloaded 

func (x *HttpRoute) GetOffloaded() bool

func (*HttpRoute) GetPatch 

func (x *HttpRoute) GetPatch() string

func (*HttpRoute) GetPattern 

func (m *HttpRoute) GetPattern() isHttpRoute_Pattern

func (*HttpRoute) GetPost 

func (x *HttpRoute) GetPost() string

func (*HttpRoute) GetPut 

func (x *HttpRoute) GetPut() string

func (*HttpRoute) ProtoMessage 

func (*HttpRoute) ProtoMessage()

func (*HttpRoute) ProtoReflect 

func (x *HttpRoute) ProtoReflect() protoreflect.Message

func (*HttpRoute) Reset 

func (x *HttpRoute) Reset()

func (*HttpRoute) String 

func (x *HttpRoute) String() string

type HttpRoute_Delete 

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 

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 

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 

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 

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

type Reply 

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
}

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

func (*Reply) Descriptor deprecated 

func (*Reply) Descriptor() ([]byte, []int)

Deprecated: Use Reply.ProtoReflect.Descriptor instead.

func (*Reply) GetException 

func (x *Reply) GetException() *ExceptionMessage

func (*Reply) GetReplyTo 

func (x *Reply) GetReplyTo() int32

func (*Reply) ProtoMessage 

func (*Reply) ProtoMessage()

func (*Reply) ProtoReflect 

func (x *Reply) ProtoReflect() protoreflect.Message

func (*Reply) Reset 

func (x *Reply) Reset()

func (*Reply) String 

func (x *Reply) String() string

type ServerMessage 

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
}

func (*ServerMessage) Descriptor deprecated 

func (*ServerMessage) Descriptor() ([]byte, []int)

Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.

func (*ServerMessage) GetCall 

func (x *ServerMessage) GetCall() int32

func (*ServerMessage) GetData 

func (x *ServerMessage) GetData() *any1.Any

func (*ServerMessage) GetSeq 

func (x *ServerMessage) GetSeq() int32

func (*ServerMessage) GetType 

func (x *ServerMessage) GetType() string

func (*ServerMessage) ProtoMessage 

func (*ServerMessage) ProtoMessage()

func (*ServerMessage) ProtoReflect 

func (x *ServerMessage) ProtoReflect() protoreflect.Message

func (*ServerMessage) Reset 

func (x *ServerMessage) Reset()

func (*ServerMessage) String 

func (x *ServerMessage) String() string

type State 

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

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

func (*State) Descriptor deprecated 

func (*State) Descriptor() ([]byte, []int)

Deprecated: Use State.ProtoReflect.Descriptor instead.

func (*State) GetCalls 

func (x *State) GetCalls() []*State_CallInfo

func (*State) ProtoMessage 

func (*State) ProtoMessage()

func (*State) ProtoReflect 

func (x *State) ProtoReflect() protoreflect.Message

func (*State) Reset 

func (x *State) Reset()

func (*State) String 

func (x *State) String() string

type State_CallInfo 

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
}

func (*State_CallInfo) Descriptor deprecated 

func (*State_CallInfo) Descriptor() ([]byte, []int)

Deprecated: Use State_CallInfo.ProtoReflect.Descriptor instead.

func (*State_CallInfo) GetCall 

func (x *State_CallInfo) GetCall() int32

func (*State_CallInfo) GetOptions 

func (x *State_CallInfo) GetOptions() *any1.Any

func (*State_CallInfo) GetType 

func (x *State_CallInfo) GetType() string

func (*State_CallInfo) ProtoMessage 

func (*State_CallInfo) ProtoMessage()

func (*State_CallInfo) ProtoReflect 

func (x *State_CallInfo) ProtoReflect() protoreflect.Message

func (*State_CallInfo) Reset 

func (x *State_CallInfo) Reset()

func (*State_CallInfo) String 

func (x *State_CallInfo) String() string

type WebSocketTopic 

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
}

func (*WebSocketTopic) Descriptor deprecated 

func (*WebSocketTopic) Descriptor() ([]byte, []int)

Deprecated: Use WebSocketTopic.ProtoReflect.Descriptor instead.

func (*WebSocketTopic) GetAdditionalBindings 

func (x *WebSocketTopic) GetAdditionalBindings() []*WebSocketTopic

func (*WebSocketTopic) GetDeprecated 

func (x *WebSocketTopic) GetDeprecated() bool

func (*WebSocketTopic) GetTopic 

func (x *WebSocketTopic) GetTopic() string

func (*WebSocketTopic) ProtoMessage 

func (*WebSocketTopic) ProtoMessage()

func (*WebSocketTopic) ProtoReflect 

func (x *WebSocketTopic) ProtoReflect() protoreflect.Message

func (*WebSocketTopic) Reset 

func (x *WebSocketTopic) Reset()

func (*WebSocketTopic) String 

func (x *WebSocketTopic) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.