lightstep.com.google.api.HttpRuleOrBuilder Maven / Gradle / Ivy

Go to download
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/api/http.proto

package lightstep.lightstep.lightstep.com.google.api;

public interface HttpRuleOrBuilder extends
    // @@protoc_insertion_point(interface_extends:google.api.HttpRule)
    lightstep.com.lightstep.lightstep.lightstep.google.protobuf.MessageOrBuilder {

  /**
   *    * Selects a method to which this rule applies.
   * Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
   * 
   *
   * string selector = 1;
   */
  String getSelector();
  /**
   *    * Selects a method to which this rule applies.
   * Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
   * 
   *
   * string selector = 1;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getSelectorBytes();

  /**
   *    * Maps to HTTP GET. Used for listing and getting information about
   * resources.
   * 
   *
   * string get = 2;
   */
  String getGet();
  /**
   *    * Maps to HTTP GET. Used for listing and getting information about
   * resources.
   * 
   *
   * string get = 2;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getGetBytes();

  /**
   *    * Maps to HTTP PUT. Used for replacing a resource.
   * 
   *
   * string put = 3;
   */
  String getPut();
  /**
   *    * Maps to HTTP PUT. Used for replacing a resource.
   * 
   *
   * string put = 3;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getPutBytes();

  /**
   *    * Maps to HTTP POST. Used for creating a resource or performing an action.
   * 
   *
   * string post = 4;
   */
  String getPost();
  /**
   *    * Maps to HTTP POST. Used for creating a resource or performing an action.
   * 
   *
   * string post = 4;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getPostBytes();

  /**
   *    * Maps to HTTP DELETE. Used for deleting a resource.
   * 
   *
   * string delete = 5;
   */
  String getDelete();
  /**
   *    * Maps to HTTP DELETE. Used for deleting a resource.
   * 
   *
   * string delete = 5;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getDeleteBytes();

  /**
   *    * Maps to HTTP PATCH. Used for updating a resource.
   * 
   *
   * string patch = 6;
   */
  String getPatch();
  /**
   *    * Maps to HTTP PATCH. Used for updating a resource.
   * 
   *
   * string patch = 6;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getPatchBytes();

  /**
   *    * The custom pattern is used for specifying an HTTP method that is not
   * included in the `pattern` field, such as HEAD, or "*" to leave the
   * HTTP method unspecified for this rule. The wild-card rule is useful
   * for services that provide content to Web (HTML) clients.
   * 
   *
   * .google.api.CustomHttpPattern custom = 8;
   */
  boolean hasCustom();
  /**
   *    * The custom pattern is used for specifying an HTTP method that is not
   * included in the `pattern` field, such as HEAD, or "*" to leave the
   * HTTP method unspecified for this rule. The wild-card rule is useful
   * for services that provide content to Web (HTML) clients.
   * 
   *
   * .google.api.CustomHttpPattern custom = 8;
   */
  CustomHttpPattern getCustom();
  /**
   *    * The custom pattern is used for specifying an HTTP method that is not
   * included in the `pattern` field, such as HEAD, or "*" to leave the
   * HTTP method unspecified for this rule. The wild-card rule is useful
   * for services that provide content to Web (HTML) clients.
   * 
   *
   * .google.api.CustomHttpPattern custom = 8;
   */
  lightstep.lightstep.lightstep.com.google.api.CustomHttpPatternOrBuilder getCustomOrBuilder();

  /**
   *    * The name of the request field whose value is mapped to the HTTP request
   * body, or `*` for mapping all request fields not captured by the path
   * pattern to the HTTP body, or omitted for not having any HTTP request body.
   * NOTE: the referred field must be present at the top-level of the request
   * message type.
   * 
   *
   * string body = 7;
   */
  String getBody();
  /**
   *    * The name of the request field whose value is mapped to the HTTP request
   * body, or `*` for mapping all request fields not captured by the path
   * pattern to the HTTP body, or omitted for not having any HTTP request body.
   * NOTE: the referred field must be present at the top-level of the request
   * message type.
   * 
   *
   * string body = 7;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getBodyBytes();

  /**
   *    * Optional. The name of the response field whose value is mapped to the HTTP
   * response body. When omitted, the entire response message will be used
   * as the HTTP response body.
   * NOTE: The referred field must be present at the top-level of the response
   * message type.
   * 
   *
   * string response_body = 12;
   */
  String getResponseBody();
  /**
   *    * Optional. The name of the response field whose value is mapped to the HTTP
   * response body. When omitted, the entire response message will be used
   * as the HTTP response body.
   * NOTE: The referred field must be present at the top-level of the response
   * message type.
   * 
   *
   * string response_body = 12;
   */
  lightstep.com.lightstep.lightstep.lightstep.google.protobuf.ByteString
      getResponseBodyBytes();

  /**
   *    * Additional HTTP bindings for the selector. Nested bindings must
   * not contain an `additional_bindings` field themselves (that is,
   * the nesting may only be one level deep).
   * 
   *
   * repeated .google.api.HttpRule additional_bindings = 11;
   */
  java.util.List
      getAdditionalBindingsList();
  /**
   *    * Additional HTTP bindings for the selector. Nested bindings must
   * not contain an `additional_bindings` field themselves (that is,
   * the nesting may only be one level deep).
   * 
   *
   * repeated .google.api.HttpRule additional_bindings = 11;
   */
  HttpRule getAdditionalBindings(int index);
  /**
   *    * Additional HTTP bindings for the selector. Nested bindings must
   * not contain an `additional_bindings` field themselves (that is,
   * the nesting may only be one level deep).
   * 
   *
   * repeated .google.api.HttpRule additional_bindings = 11;
   */
  int getAdditionalBindingsCount();
  /**
   *    * Additional HTTP bindings for the selector. Nested bindings must
   * not contain an `additional_bindings` field themselves (that is,
   * the nesting may only be one level deep).
   * 
   *
   * repeated .google.api.HttpRule additional_bindings = 11;
   */
  java.util.List
      getAdditionalBindingsOrBuilderList();
  /**
   *    * Additional HTTP bindings for the selector. Nested bindings must
   * not contain an `additional_bindings` field themselves (that is,
   * the nesting may only be one level deep).
   * 
   *
   * repeated .google.api.HttpRule additional_bindings = 11;
   */
  HttpRuleOrBuilder getAdditionalBindingsOrBuilder(
      int index);

  public HttpRule.PatternCase getPatternCase();
}