Package org.yamcs.api

Class HttpRoute

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.api.HttpRoute
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, HttpRouteOrBuilder

public final class HttpRoute extends com.google.protobuf.GeneratedMessageV3 implements HttpRouteOrBuilder
Protobuf type yamcs.api.HttpRoute
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Protobuf type yamcs.api.HttpRoute
    static enum 
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final com.google.protobuf.Parser<HttpRoute>
    Deprecated.
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    repeated .yamcs.api.HttpRoute additional_bindings = 11;
    int
    repeated .yamcs.api.HttpRoute additional_bindings = 11;
    repeated .yamcs.api.HttpRoute additional_bindings = 11;
    repeated .yamcs.api.HttpRoute additional_bindings = 11;
    repeated .yamcs.api.HttpRoute additional_bindings = 11;
    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).
    com.google.protobuf.ByteString
    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).
    static HttpRoute
     
     
    Maps to HTTP DELETE.
    com.google.protobuf.ByteString
    Maps to HTTP DELETE.
    boolean
    optional bool deprecated = 6;
    static final com.google.protobuf.Descriptors.Descriptor
     
    Name of the field in the response message where a user-specified field mask is applied to.
    com.google.protobuf.ByteString
    Name of the field in the response message where a user-specified field mask is applied to.
    Maps to HTTP GET.
    com.google.protobuf.ByteString
    Maps to HTTP GET.
    Human-friendly log message format.
    com.google.protobuf.ByteString
    Human-friendly log message format.
    int
    optional int32 max_body_size = 8;
    boolean
    Set true if the execution of the route is expected to take a long time (more than 0.5 seconds).
    com.google.protobuf.Parser<HttpRoute>
     
    Maps to HTTP PATCH.
    com.google.protobuf.ByteString
    Maps to HTTP PATCH.
     
    Maps to HTTP POST.
    com.google.protobuf.ByteString
    Maps to HTTP POST.
    Maps to HTTP PUT.
    com.google.protobuf.ByteString
    Maps to HTTP PUT.
    int
     
    final com.google.protobuf.UnknownFieldSet
     
    boolean
    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).
    boolean
    Maps to HTTP DELETE.
    boolean
    optional bool deprecated = 6;
    boolean
    Name of the field in the response message where a user-specified field mask is applied to.
    boolean
    Maps to HTTP GET.
    int
     
    boolean
    Human-friendly log message format.
    boolean
    optional int32 max_body_size = 8;
    boolean
    Set true if the execution of the route is expected to take a long time (more than 0.5 seconds).
    boolean
    Maps to HTTP PATCH.
    boolean
    Maps to HTTP POST.
    boolean
    Maps to HTTP PUT.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
    newBuilder(HttpRoute prototype)
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static HttpRoute
     
    static HttpRoute
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRoute
    parseFrom(byte[] data)
     
    static HttpRoute
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRoute
    parseFrom(com.google.protobuf.ByteString data)
     
    static HttpRoute
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRoute
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static HttpRoute
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRoute
     
    static HttpRoute
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static HttpRoute
     
    static HttpRoute
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<HttpRoute>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • getPatternCase

      public HttpRoute.PatternCase getPatternCase()
      Specified by:
      getPatternCase in interface HttpRouteOrBuilder
    • hasGet

      public boolean hasGet()
       Maps to HTTP GET. Used for listing and getting information about
       resources.
       
      string get = 1;
      Specified by:
      hasGet in interface HttpRouteOrBuilder
      Returns:
      Whether the get field is set.
    • getGet

      public String getGet()
       Maps to HTTP GET. Used for listing and getting information about
       resources.
       
      string get = 1;
      Specified by:
      getGet in interface HttpRouteOrBuilder
      Returns:
      The get.
    • getGetBytes

      public com.google.protobuf.ByteString getGetBytes()
       Maps to HTTP GET. Used for listing and getting information about
       resources.
       
      string get = 1;
      Specified by:
      getGetBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for get.
    • hasPut

      public boolean hasPut()
       Maps to HTTP PUT. Used for replacing a resource.
       
      string put = 2;
      Specified by:
      hasPut in interface HttpRouteOrBuilder
      Returns:
      Whether the put field is set.
    • getPut

      public String getPut()
       Maps to HTTP PUT. Used for replacing a resource.
       
      string put = 2;
      Specified by:
      getPut in interface HttpRouteOrBuilder
      Returns:
      The put.
    • getPutBytes

      public com.google.protobuf.ByteString getPutBytes()
       Maps to HTTP PUT. Used for replacing a resource.
       
      string put = 2;
      Specified by:
      getPutBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for put.
    • hasPost

      public boolean hasPost()
       Maps to HTTP POST. Used for creating a resource or performing an action.
       
      string post = 3;
      Specified by:
      hasPost in interface HttpRouteOrBuilder
      Returns:
      Whether the post field is set.
    • getPost

      public String getPost()
       Maps to HTTP POST. Used for creating a resource or performing an action.
       
      string post = 3;
      Specified by:
      getPost in interface HttpRouteOrBuilder
      Returns:
      The post.
    • getPostBytes

      public com.google.protobuf.ByteString getPostBytes()
       Maps to HTTP POST. Used for creating a resource or performing an action.
       
      string post = 3;
      Specified by:
      getPostBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for post.
    • hasDelete

      public boolean hasDelete()
       Maps to HTTP DELETE. Used for deleting a resource.
       
      string delete = 4;
      Specified by:
      hasDelete in interface HttpRouteOrBuilder
      Returns:
      Whether the delete field is set.
    • getDelete

      public String getDelete()
       Maps to HTTP DELETE. Used for deleting a resource.
       
      string delete = 4;
      Specified by:
      getDelete in interface HttpRouteOrBuilder
      Returns:
      The delete.
    • getDeleteBytes

      public com.google.protobuf.ByteString getDeleteBytes()
       Maps to HTTP DELETE. Used for deleting a resource.
       
      string delete = 4;
      Specified by:
      getDeleteBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for delete.
    • hasPatch

      public boolean hasPatch()
       Maps to HTTP PATCH. Used for updating a resource.
       
      string patch = 5;
      Specified by:
      hasPatch in interface HttpRouteOrBuilder
      Returns:
      Whether the patch field is set.
    • getPatch

      public String getPatch()
       Maps to HTTP PATCH. Used for updating a resource.
       
      string patch = 5;
      Specified by:
      getPatch in interface HttpRouteOrBuilder
      Returns:
      The patch.
    • getPatchBytes

      public com.google.protobuf.ByteString getPatchBytes()
       Maps to HTTP PATCH. Used for updating a resource.
       
      string patch = 5;
      Specified by:
      getPatchBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for patch.
    • hasDeprecated

      public boolean hasDeprecated()
      optional bool deprecated = 6;
      Specified by:
      hasDeprecated in interface HttpRouteOrBuilder
      Returns:
      Whether the deprecated field is set.
    • getDeprecated

      public boolean getDeprecated()
      optional bool deprecated = 6;
      Specified by:
      getDeprecated in interface HttpRouteOrBuilder
      Returns:
      The deprecated.
    • hasBody

      public boolean hasBody()
       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).
       
      optional string body = 7;
      Specified by:
      hasBody in interface HttpRouteOrBuilder
      Returns:
      Whether the body field is set.
    • getBody

      public String getBody()
       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).
       
      optional string body = 7;
      Specified by:
      getBody in interface HttpRouteOrBuilder
      Returns:
      The body.
    • getBodyBytes

      public com.google.protobuf.ByteString getBodyBytes()
       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).
       
      optional string body = 7;
      Specified by:
      getBodyBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for body.
    • hasMaxBodySize

      public boolean hasMaxBodySize()
      optional int32 max_body_size = 8;
      Specified by:
      hasMaxBodySize in interface HttpRouteOrBuilder
      Returns:
      Whether the maxBodySize field is set.
    • getMaxBodySize

      public int getMaxBodySize()
      optional int32 max_body_size = 8;
      Specified by:
      getMaxBodySize in interface HttpRouteOrBuilder
      Returns:
      The maxBodySize.
    • hasOffloaded

      public boolean hasOffloaded()
       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).
       
      optional bool offloaded = 9;
      Specified by:
      hasOffloaded in interface HttpRouteOrBuilder
      Returns:
      Whether the offloaded field is set.
    • getOffloaded

      public boolean getOffloaded()
       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).
       
      optional bool offloaded = 9;
      Specified by:
      getOffloaded in interface HttpRouteOrBuilder
      Returns:
      The offloaded.
    • hasFieldMaskRoot

      public boolean hasFieldMaskRoot()
       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.
       
      optional string field_mask_root = 10;
      Specified by:
      hasFieldMaskRoot in interface HttpRouteOrBuilder
      Returns:
      Whether the fieldMaskRoot field is set.
    • getFieldMaskRoot

      public String getFieldMaskRoot()
       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.
       
      optional string field_mask_root = 10;
      Specified by:
      getFieldMaskRoot in interface HttpRouteOrBuilder
      Returns:
      The fieldMaskRoot.
    • getFieldMaskRootBytes

      public com.google.protobuf.ByteString getFieldMaskRootBytes()
       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.
       
      optional string field_mask_root = 10;
      Specified by:
      getFieldMaskRootBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for fieldMaskRoot.
    • getAdditionalBindingsList

      public List<HttpRoute> getAdditionalBindingsList()
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      Specified by:
      getAdditionalBindingsList in interface HttpRouteOrBuilder
    • getAdditionalBindingsOrBuilderList

      public List<? extends HttpRouteOrBuilder> getAdditionalBindingsOrBuilderList()
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      Specified by:
      getAdditionalBindingsOrBuilderList in interface HttpRouteOrBuilder
    • getAdditionalBindingsCount

      public int getAdditionalBindingsCount()
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      Specified by:
      getAdditionalBindingsCount in interface HttpRouteOrBuilder
    • getAdditionalBindings

      public HttpRoute getAdditionalBindings(int index)
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      Specified by:
      getAdditionalBindings in interface HttpRouteOrBuilder
    • getAdditionalBindingsOrBuilder

      public HttpRouteOrBuilder getAdditionalBindingsOrBuilder(int index)
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      Specified by:
      getAdditionalBindingsOrBuilder in interface HttpRouteOrBuilder
    • hasLog

      public boolean hasLog()
       Human-friendly log message format.
       
      optional string log = 12;
      Specified by:
      hasLog in interface HttpRouteOrBuilder
      Returns:
      Whether the log field is set.
    • getLog

      public String getLog()
       Human-friendly log message format.
       
      optional string log = 12;
      Specified by:
      getLog in interface HttpRouteOrBuilder
      Returns:
      The log.
    • getLogBytes

      public com.google.protobuf.ByteString getLogBytes()
       Human-friendly log message format.
       
      optional string log = 12;
      Specified by:
      getLogBytes in interface HttpRouteOrBuilder
      Returns:
      The bytes for log.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static HttpRoute parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static HttpRoute parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static HttpRoute parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static HttpRoute parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static HttpRoute parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static HttpRoute parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static HttpRoute parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static HttpRoute parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static HttpRoute parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static HttpRoute parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static HttpRoute parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static HttpRoute parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public HttpRoute.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static HttpRoute.Builder newBuilder()
    • newBuilder

      public static HttpRoute.Builder newBuilder(HttpRoute prototype)
    • toBuilder

      public HttpRoute.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected HttpRoute.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static HttpRoute getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<HttpRoute> parser()
    • getParserForType

      public com.google.protobuf.Parser<HttpRoute> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public HttpRoute getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder