Package org.yamcs.api

Class 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:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HttpRoute.Builder
      Protobuf type yamcs.api.HttpRoute
      static class  HttpRoute.PatternCase  

      • 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

    • Method Detail

      • 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

      • hasGet

        public boolean hasGet()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        optional string get = 1;
        Specified by:
        hasGet in interface HttpRouteOrBuilder

      • getGet

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

      • getGetBytes

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

      • hasPut

        public boolean hasPut()
         Maps to HTTP PUT. Used for replacing a resource.
        optional string put = 2;
        Specified by:
        hasPut in interface HttpRouteOrBuilder

      • getPut

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

      • getPutBytes

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

      • hasPost

        public boolean hasPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        optional string post = 3;
        Specified by:
        hasPost in interface HttpRouteOrBuilder

      • getPost

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

      • getPostBytes

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

      • hasDelete

        public boolean hasDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        optional string delete = 4;
        Specified by:
        hasDelete in interface HttpRouteOrBuilder

      • getDelete

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

      • getDeleteBytes

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

      • hasPatch

        public boolean hasPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        optional string patch = 5;
        Specified by:
        hasPatch in interface HttpRouteOrBuilder

      • getPatch

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

      • getPatchBytes

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

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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

      • 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​(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

      • 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