Package com.google.api

Interface HttpRuleOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      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.
      HttpRuleOrBuilder getAdditionalBindingsOrBuilder​(int index)
      Additional HTTP bindings for the selector.
      List<? extends HttpRuleOrBuilder> getAdditionalBindingsOrBuilderList()
      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.
      CustomHttpPatternOrBuilder getCustomOrBuilder()
      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.

      • 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

      • getSelector

        String getSelector()
         Selects a method to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
        string selector = 1;

      • 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;

      • getGet

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

      • getGetBytes

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

      • getPut

        String getPut()
         Maps to HTTP PUT. Used for replacing a resource.
        string put = 3;

      • getPutBytes

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

      • getPost

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

      • getPostBytes

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

      • getDelete

        String getDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
        string delete = 5;

      • getDeleteBytes

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

      • getPatch

        String getPatch()
         Maps to HTTP PATCH. Used for updating a resource.
        string patch = 6;

      • getPatchBytes

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

      • 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;

      • 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;

      • getCustomOrBuilder

        CustomHttpPatternOrBuilder getCustomOrBuilder()
         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;

      • 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;

      • 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;

      • 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;

      • 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;

      • 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;

      • 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;

      • 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;

      • getAdditionalBindingsOrBuilderList

        List<? extends HttpRuleOrBuilder> 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;

      • getAdditionalBindingsOrBuilder

        HttpRuleOrBuilder getAdditionalBindingsOrBuilder​(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;