org.yamcs.api.HttpRouteOrBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/api/annotations.proto

package org.yamcs.api;

public interface HttpRouteOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.api.HttpRoute)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Maps to HTTP GET. Used for listing and getting information about
   * resources.
   * 
   *
   * optional string get = 1;
   */
  boolean hasGet();
  /**
   *    * Maps to HTTP GET. Used for listing and getting information about
   * resources.
   * 
   *
   * optional string get = 1;
   */
  java.lang.String getGet();
  /**
   *    * Maps to HTTP GET. Used for listing and getting information about
   * resources.
   * 
   *
   * optional string get = 1;
   */
  com.google.protobuf.ByteString
      getGetBytes();

  /**
   *    * Maps to HTTP PUT. Used for replacing a resource.
   * 
   *
   * optional string put = 2;
   */
  boolean hasPut();
  /**
   *    * Maps to HTTP PUT. Used for replacing a resource.
   * 
   *
   * optional string put = 2;
   */
  java.lang.String getPut();
  /**
   *    * Maps to HTTP PUT. Used for replacing a resource.
   * 
   *
   * optional string put = 2;
   */
  com.google.protobuf.ByteString
      getPutBytes();

  /**
   *    * Maps to HTTP POST. Used for creating a resource or performing an action.
   * 
   *
   * optional string post = 3;
   */
  boolean hasPost();
  /**
   *    * Maps to HTTP POST. Used for creating a resource or performing an action.
   * 
   *
   * optional string post = 3;
   */
  java.lang.String getPost();
  /**
   *    * Maps to HTTP POST. Used for creating a resource or performing an action.
   * 
   *
   * optional string post = 3;
   */
  com.google.protobuf.ByteString
      getPostBytes();

  /**
   *    * Maps to HTTP DELETE. Used for deleting a resource.
   * 
   *
   * optional string delete = 4;
   */
  boolean hasDelete();
  /**
   *    * Maps to HTTP DELETE. Used for deleting a resource.
   * 
   *
   * optional string delete = 4;
   */
  java.lang.String getDelete();
  /**
   *    * Maps to HTTP DELETE. Used for deleting a resource.
   * 
   *
   * optional string delete = 4;
   */
  com.google.protobuf.ByteString
      getDeleteBytes();

  /**
   *    * Maps to HTTP PATCH. Used for updating a resource.
   * 
   *
   * optional string patch = 5;
   */
  boolean hasPatch();
  /**
   *    * Maps to HTTP PATCH. Used for updating a resource.
   * 
   *
   * optional string patch = 5;
   */
  java.lang.String getPatch();
  /**
   *    * Maps to HTTP PATCH. Used for updating a resource.
   * 
   *
   * optional string patch = 5;
   */
  com.google.protobuf.ByteString
      getPatchBytes();

  /**
   * optional bool deprecated = 6;
   */
  boolean hasDeprecated();
  /**
   * optional bool deprecated = 6;
   */
  boolean getDeprecated();

  /**
   *    * 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;
   */
  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;
   */
  java.lang.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;
   */
  com.google.protobuf.ByteString
      getBodyBytes();

  /**
   * optional int32 maxBodySize = 8;
   */
  boolean hasMaxBodySize();
  /**
   * optional int32 maxBodySize = 8;
   */
  int getMaxBodySize();

  /**
   *    * 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 offThread = 9;
   */
  boolean hasOffThread();
  /**
   *    * 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 offThread = 9;
   */
  boolean getOffThread();

  /**
   *    * Data load routes expect to receive a large body piece by piece in
   * HttpContent objects.
   * 
   * If false or unset, a small default is used, sufficient for standard use.
   * 
   *
   * optional bool dataLoad = 10;
   */
  boolean hasDataLoad();
  /**
   *    * Data load routes expect to receive a large body piece by piece in
   * HttpContent objects.
   * 
   * If false or unset, a small default is used, sufficient for standard use.
   * 
   *
   * optional bool dataLoad = 10;
   */
  boolean getDataLoad();

  /**
   * repeated .yamcs.api.HttpRoute additional_bindings = 11;
   */
  java.util.List 
      getAdditionalBindingsList();
  /**
   * repeated .yamcs.api.HttpRoute additional_bindings = 11;
   */
  org.yamcs.api.HttpRoute getAdditionalBindings(int index);
  /**
   * repeated .yamcs.api.HttpRoute additional_bindings = 11;
   */
  int getAdditionalBindingsCount();
  /**
   * repeated .yamcs.api.HttpRoute additional_bindings = 11;
   */
  java.util.List 
      getAdditionalBindingsOrBuilderList();
  /**
   * repeated .yamcs.api.HttpRoute additional_bindings = 11;
   */
  org.yamcs.api.HttpRouteOrBuilder getAdditionalBindingsOrBuilder(
      int index);

  public org.yamcs.api.HttpRoute.PatternCase getPatternCase();
}