Package com.google.api

Interface HttpRuleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
HttpRule, HttpRule.Builder
public interface HttpRuleOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    HttpRule
    getAdditionalBindings(int index)
    Additional HTTP bindings for the selector.
    int
    getAdditionalBindingsCount()
    Additional HTTP bindings for the selector.
    List<HttpRule>
    getAdditionalBindingsList()
    Additional HTTP bindings for the selector.
    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.
    com.google.protobuf.ByteString
    getBodyBytes()
    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.
    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.
    String
    getDelete()
    Maps to HTTP DELETE.
    com.google.protobuf.ByteString
    getDeleteBytes()
    Maps to HTTP DELETE.
    String
    getGet()
    Maps to HTTP GET.
    com.google.protobuf.ByteString
    getGetBytes()
    Maps to HTTP GET.
    String
    getPatch()
    Maps to HTTP PATCH.
    com.google.protobuf.ByteString
    getPatchBytes()
    Maps to HTTP PATCH.
    HttpRule.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.
    String
    getResponseBody()
    Optional.
    com.google.protobuf.ByteString
    getResponseBodyBytes()
    Optional.
    String
    getSelector()
    Selects a method to which this rule applies.
    com.google.protobuf.ByteString
    getSelectorBytes()
    Selects a method to which this rule applies.
    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.
    boolean
    hasDelete()
    Maps to HTTP DELETE.
    boolean
    hasGet()
    Maps to HTTP GET.
    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

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getSelector

      String getSelector()
       Selects a method to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1 [json_name = "selector"];
      Returns:
      The selector.

    • getSelectorBytes

      com.google.protobuf.ByteString getSelectorBytes()
       Selects a method to which this rule applies.

 Refer to [selector][google.api.DocumentationRule.selector] for syntax
 details.
      string selector = 1 [json_name = "selector"];
      Returns:
      The bytes for selector.

    • hasGet

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

    • getGet

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

    • getGetBytes

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

    • hasPut

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

    • getPut

      String getPut()
       Maps to HTTP PUT. Used for replacing a resource.
      string put = 3 [json_name = "put"];
      Returns:
      The put.

    • getPutBytes

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

    • hasPost

      boolean hasPost()
       Maps to HTTP POST. Used for creating a resource or performing an action.
      string post = 4 [json_name = "post"];
      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 = 4 [json_name = "post"];
      Returns:
      The post.

    • getPostBytes

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

    • hasDelete

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

    • getDelete

      String getDelete()
       Maps to HTTP DELETE. Used for deleting a resource.
      string delete = 5 [json_name = "delete"];
      Returns:
      The delete.

    • getDeleteBytes

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

    • hasPatch

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

    • getPatch

      String getPatch()
       Maps to HTTP PATCH. Used for updating a resource.
      string patch = 6 [json_name = "patch"];
      Returns:
      The patch.

    • getPatchBytes

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

    • hasCustom

      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 [json_name = "custom"];
      Returns:
      Whether the custom field is set.

    • getCustom

      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 [json_name = "custom"];
      Returns:
      The custom.

    • getBody

      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 [json_name = "body"];
      Returns:
      The body.

    • getBodyBytes

      com.google.protobuf.ByteString getBodyBytes()
       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 [json_name = "body"];
      Returns:
      The bytes for body.

    • getResponseBody

      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 [json_name = "responseBody"];
      Returns:
      The responseBody.

    • getResponseBodyBytes

      com.google.protobuf.ByteString getResponseBodyBytes()
       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 [json_name = "responseBody"];
      Returns:
      The bytes for responseBody.

    • getAdditionalBindingsList

      List<HttpRule> 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 [json_name = "additionalBindings"];

    • getAdditionalBindings

      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 [json_name = "additionalBindings"];

    • getAdditionalBindingsCount

      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 [json_name = "additionalBindings"];

    • getPatternCase

      HttpRule.PatternCase getPatternCase()