Package org.yamcs.api

Interface HttpRouteOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    HttpRoute, HttpRoute.Builder
    public interface HttpRouteOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      HttpRoute getAdditionalBindings​(int index)
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      int getAdditionalBindingsCount()
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      List<HttpRoute> getAdditionalBindingsList()
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      HttpRouteOrBuilder getAdditionalBindingsOrBuilder​(int index)
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      List<? extends HttpRouteOrBuilder> getAdditionalBindingsOrBuilderList()
      repeated .yamcs.api.HttpRoute additional_bindings = 11;
      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).
      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).
      String getDelete()
      Maps to HTTP DELETE.
      com.google.protobuf.ByteString getDeleteBytes()
      Maps to HTTP DELETE.
      boolean getDeprecated()
      optional bool deprecated = 6;
      String getFieldMaskRoot()
      Name of the field in the response message where a user-specified field mask is applied to.
      com.google.protobuf.ByteString getFieldMaskRootBytes()
      Name of the field in the response message where a user-specified field mask is applied to.
      String getGet()
      Maps to HTTP GET.
      com.google.protobuf.ByteString getGetBytes()
      Maps to HTTP GET.
      String getLog()
      Human-friendly log message format.
      com.google.protobuf.ByteString getLogBytes()
      Human-friendly log message format.
      int getMaxBodySize()
      optional int32 max_body_size = 8;
      boolean getOffloaded()
      Set true if the execution of the route is expected to take a long time (more than 0.5 seconds).
      String getPatch()
      Maps to HTTP PATCH.
      com.google.protobuf.ByteString getPatchBytes()
      Maps to HTTP PATCH.
      HttpRoute.PatternCase getPatternCase()  
      String getPost()
      Maps to HTTP POST.
      com.google.protobuf.ByteString getPostBytes()
      Maps to HTTP POST.
      String getPut()
      Maps to HTTP PUT.
      com.google.protobuf.ByteString getPutBytes()
      Maps to HTTP PUT.
      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).
      boolean hasDelete()
      Maps to HTTP DELETE.
      boolean hasDeprecated()
      optional bool deprecated = 6;
      boolean hasFieldMaskRoot()
      Name of the field in the response message where a user-specified field mask is applied to.
      boolean hasGet()
      Maps to HTTP GET.
      boolean hasLog()
      Human-friendly log message format.
      boolean hasMaxBodySize()
      optional int32 max_body_size = 8;
      boolean hasOffloaded()
      Set true if the execution of the route is expected to take a long time (more than 0.5 seconds).
      boolean hasPatch()
      Maps to HTTP PATCH.
      boolean hasPost()
      Maps to HTTP POST.
      boolean hasPut()
      Maps to HTTP PUT.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasGet

        boolean hasGet()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Returns:
        Whether the get field is set.

      • getGet

        String getGet()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Returns:
        The get.

      • getGetBytes

        com.google.protobuf.ByteString getGetBytes()
         Maps to HTTP GET. Used for listing and getting information about
 resources.
        string get = 1;
        Returns:
        The bytes for get.

      • hasPut

        boolean hasPut()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Returns:
        Whether the put field is set.

      • getPut

        String getPut()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Returns:
        The put.

      • getPutBytes

        com.google.protobuf.ByteString getPutBytes()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 2;
        Returns:
        The bytes for put.

      • hasPost

        boolean hasPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Returns:
        Whether the post field is set.

      • getPost

        String getPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Returns:
        The post.

      • getPostBytes

        com.google.protobuf.ByteString getPostBytes()
         Maps to HTTP POST. Used for creating a resource or performing an action.
        string post = 3;
        Returns:
        The bytes for post.

      • hasDelete

        boolean hasDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Returns:
        Whether the delete field is set.

      • getDelete

        String getDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Returns:
        The delete.

      • getDeleteBytes

        com.google.protobuf.ByteString getDeleteBytes()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 4;
        Returns:
        The bytes for delete.

      • hasPatch

        boolean hasPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Returns:
        Whether the patch field is set.

      • getPatch

        String getPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Returns:
        The patch.

      • getPatchBytes

        com.google.protobuf.ByteString getPatchBytes()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 5;
        Returns:
        The bytes for patch.

      • hasDeprecated

        boolean hasDeprecated()
        optional bool deprecated = 6;
        Returns:
        Whether the deprecated field is set.

      • getDeprecated

        boolean getDeprecated()
        optional bool deprecated = 6;
        Returns:
        The deprecated.

      • hasBody

        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;
        Returns:
        Whether the body field is set.

      • getBody

        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;
        Returns:
        The body.

      • getBodyBytes

        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;
        Returns:
        The bytes for body.

      • hasMaxBodySize

        boolean hasMaxBodySize()
        optional int32 max_body_size = 8;
        Returns:
        Whether the maxBodySize field is set.

      • getMaxBodySize

        int getMaxBodySize()
        optional int32 max_body_size = 8;
        Returns:
        The maxBodySize.

      • hasOffloaded

        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;
        Returns:
        Whether the offloaded field is set.

      • getOffloaded

        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;
        Returns:
        The offloaded.

      • hasFieldMaskRoot

        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;
        Returns:
        Whether the fieldMaskRoot field is set.

      • getFieldMaskRoot

        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;
        Returns:
        The fieldMaskRoot.

      • getFieldMaskRootBytes

        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;
        Returns:
        The bytes for fieldMaskRoot.

      • getAdditionalBindingsList

        List<HttpRoute> getAdditionalBindingsList()
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • getAdditionalBindings

        HttpRoute getAdditionalBindings​(int index)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • getAdditionalBindingsCount

        int getAdditionalBindingsCount()
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • getAdditionalBindingsOrBuilderList

        List<? extends HttpRouteOrBuilder> getAdditionalBindingsOrBuilderList()
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • getAdditionalBindingsOrBuilder

        HttpRouteOrBuilder getAdditionalBindingsOrBuilder​(int index)
        repeated .yamcs.api.HttpRoute additional_bindings = 11;

      • hasLog

        boolean hasLog()
         Human-friendly log message format.
        optional string log = 12;
        Returns:
        Whether the log field is set.

      • getLog

        String getLog()
         Human-friendly log message format.
        optional string log = 12;
        Returns:
        The log.

      • getLogBytes

        com.google.protobuf.ByteString getLogBytes()
         Human-friendly log message format.
        optional string log = 12;
        Returns:
        The bytes for log.