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

Class AnnotationsProto

java.lang.Object
com.google.protobuf.GeneratedFile
org.yamcs.api.AnnotationsProto
@Generated public final class AnnotationsProto extends com.google.protobuf.GeneratedFile

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FIELD_BEHAVIOR_FIELD_NUMBER
     
    static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,List<FieldBehavior>>
    fieldBehavior
    extend .google.protobuf.FieldOptions { ... }
    static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,String>
    label
    Short, human-friendly label describing this service.
    static final int
    LABEL_FIELD_NUMBER
     
    static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,Boolean>
    markdown
    If true, all comments related to this service are to be interpreted in Markdown syntax, as opposed to reStructuredText format.
    static final int
    MARKDOWN_FIELD_NUMBER
     
    static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,HttpRoute>
    route
    extend .google.protobuf.MethodOptions { ... }
    static final int
    ROUTE_FIELD_NUMBER
     
    static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,WebSocketTopic>
    websocket
    extend .google.protobuf.MethodOptions { ... }
    static final int
    WEBSOCKET_FIELD_NUMBER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static com.google.protobuf.Descriptors.FileDescriptor
    getDescriptor()
     
    static void
    registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
     
    static void
    registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)
     

    Methods inherited from class com.google.protobuf.GeneratedFile

    addOptionalExtension

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • LABEL_FIELD_NUMBER

      public static final int LABEL_FIELD_NUMBER
      See Also:

    • label

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,String> label
       Short, human-friendly label describing this service.
 This is a hint to programs that process proto
 definitions (example: document generation).

 Example:

 service MdbApi {
 option (yamcs.api.label) = "MDB";
 }
      extend .google.protobuf.ServiceOptions { ... }

    • MARKDOWN_FIELD_NUMBER

      public static final int MARKDOWN_FIELD_NUMBER
      See Also:

    • markdown

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.ServiceOptions,Boolean> markdown
       If true, all comments related to this service are to
 be interpreted in Markdown syntax, as opposed to
 reStructuredText format.

 Markdown will become the only option at some point in
 the future - when all reStructuredText services have been
 migrated. Until then we have this option to distinguish.

 When unset, reStructuredText is assumed.

 Example:

 service MdbApi {
 option (yamcs.api.markdown) = true;
 }
      extend .google.protobuf.ServiceOptions { ... }

    • ROUTE_FIELD_NUMBER

      public static final int ROUTE_FIELD_NUMBER
      See Also:

    • route

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,HttpRoute> route
      extend .google.protobuf.MethodOptions { ... }

    • WEBSOCKET_FIELD_NUMBER

      public static final int WEBSOCKET_FIELD_NUMBER
      See Also:

    • websocket

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,WebSocketTopic> websocket
      extend .google.protobuf.MethodOptions { ... }

    • FIELD_BEHAVIOR_FIELD_NUMBER

      public static final int FIELD_BEHAVIOR_FIELD_NUMBER
      See Also:

    • fieldBehavior

      public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,List<FieldBehavior>> fieldBehavior
      extend .google.protobuf.FieldOptions { ... }

  • Method Details

    • registerAllExtensions

      public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)

    • registerAllExtensions

      public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)

    • getDescriptor

      public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()