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.
      java.util.List<HttpRule> getAdditionalBindingsList()
      Additional HTTP bindings for the selector.
      HttpRuleOrBuilder getAdditionalBindingsOrBuilder​(int index)
      Additional HTTP bindings for the selector.
      java.util.List<? extends HttpRuleOrBuilder> getAdditionalBindingsOrBuilderList()
      Additional HTTP bindings for the selector.
      java.lang.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.
      java.lang.String getDelete()
      Maps to HTTP DELETE.
      com.google.protobuf.ByteString getDeleteBytes()
      Maps to HTTP DELETE.
      java.lang.String getGet()
      Maps to HTTP GET.
      com.google.protobuf.ByteString getGetBytes()
      Maps to HTTP GET.
      java.lang.String getPatch()
      Maps to HTTP PATCH.
      com.google.protobuf.ByteString getPatchBytes()
      Maps to HTTP PATCH.
      HttpRule.PatternCase getPatternCase()  
      java.lang.String getPost()
      Maps to HTTP POST.
      com.google.protobuf.ByteString getPostBytes()
      Maps to HTTP POST.
      java.lang.String getPut()
      Maps to HTTP PUT.
      com.google.protobuf.ByteString getPutBytes()
      Maps to HTTP PUT.
      java.lang.String getResponseBody()
      Optional.
      com.google.protobuf.ByteString getResponseBodyBytes()
      Optional.
      java.lang.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

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

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

      • getSelector

        java.lang.String getSelector()
         Selects a method to which this rule applies.
        
         Refer to [selector][google.api.DocumentationRule.selector] for syntax
         details.
         
        string selector = 1;
        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;
        Returns:
        The bytes for selector.
      • hasGet

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

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

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

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

        java.lang.String getPut()
         Maps to HTTP PUT. Used for replacing a resource.
         
        string put = 3;
        Returns:
        The put.
      • getPutBytes

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

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

        java.lang.String getPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
         
        string post = 4;
        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;
        Returns:
        The bytes for post.
      • hasDelete

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

        java.lang.String getDelete()
         Maps to HTTP DELETE. Used for deleting a resource.
         
        string delete = 5;
        Returns:
        The delete.
      • getDeleteBytes

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

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

        java.lang.String getPatch()
         Maps to HTTP PATCH. Used for updating a resource.
         
        string patch = 6;
        Returns:
        The patch.
      • getPatchBytes

        com.google.protobuf.ByteString getPatchBytes()
         Maps to HTTP PATCH. Used for updating a resource.
         
        string patch = 6;
        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;
        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;
        Returns:
        The custom.
      • 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

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

        java.lang.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;
        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;
        Returns:
        The bytes for responseBody.
      • getAdditionalBindingsList

        java.util.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

        java.util.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;