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 body, or `*` for mapping all fields not captured by the path pattern to the HTTP body.
      com.google.protobuf.ByteString getBodyBytes()
      The name of the request field whose value is mapped to the HTTP body, or `*` for mapping all fields not captured by the path pattern to the HTTP body.
      CustomHttpPattern getCustom()
      Custom pattern is used for defining custom verbs.
      CustomHttpPatternOrBuilder getCustomOrBuilder()
      Custom pattern is used for defining custom verbs.
      java.lang.String getDelete()
      Used for deleting a resource.
      com.google.protobuf.ByteString getDeleteBytes()
      Used for deleting a resource.
      java.lang.String getGet()
      Used for listing and getting information about resources.
      com.google.protobuf.ByteString getGetBytes()
      Used for listing and getting information about resources.
      java.lang.String getPatch()
      Used for updating a resource.
      com.google.protobuf.ByteString getPatchBytes()
      Used for updating a resource.
      HttpRule.PatternCase getPatternCase()  
      java.lang.String getPost()
      Used for creating a resource.
      com.google.protobuf.ByteString getPostBytes()
      Used for creating a resource.
      java.lang.String getPut()
      Used for updating a resource.
      com.google.protobuf.ByteString getPutBytes()
      Used for updating a resource.
      java.lang.String getSelector()
      Selects methods to which this rule applies.
      com.google.protobuf.ByteString getSelectorBytes()
      Selects methods to which this rule applies.
      boolean hasCustom()
      Custom pattern is used for defining custom verbs.
      boolean hasDelete()
      Used for deleting a resource.
      boolean hasGet()
      Used for listing and getting information about resources.
      boolean hasPatch()
      Used for updating a resource.
      boolean hasPost()
      Used for creating a resource.
      boolean hasPut()
      Used for updating a resource.
      • 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 methods 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 methods 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()
         Used for listing and getting information about resources.
         
        string get = 2;
        Returns:
        Whether the get field is set.
      • getGet

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

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

        boolean hasPut()
         Used for updating a resource.
         
        string put = 3;
        Returns:
        Whether the put field is set.
      • getPut

        java.lang.String getPut()
         Used for updating a resource.
         
        string put = 3;
        Returns:
        The put.
      • getPutBytes

        com.google.protobuf.ByteString getPutBytes()
         Used for updating a resource.
         
        string put = 3;
        Returns:
        The bytes for put.
      • hasPost

        boolean hasPost()
         Used for creating a resource.
         
        string post = 4;
        Returns:
        Whether the post field is set.
      • getPost

        java.lang.String getPost()
         Used for creating a resource.
         
        string post = 4;
        Returns:
        The post.
      • getPostBytes

        com.google.protobuf.ByteString getPostBytes()
         Used for creating a resource.
         
        string post = 4;
        Returns:
        The bytes for post.
      • hasDelete

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

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

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

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

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

        com.google.protobuf.ByteString getPatchBytes()
         Used for updating a resource.
         
        string patch = 6;
        Returns:
        The bytes for patch.
      • hasCustom

        boolean hasCustom()
         Custom pattern is used for defining custom verbs.
         
        .google.api.CustomHttpPattern custom = 8;
        Returns:
        Whether the custom field is set.
      • getCustom

        CustomHttpPattern getCustom()
         Custom pattern is used for defining custom verbs.
         
        .google.api.CustomHttpPattern custom = 8;
        Returns:
        The custom.
      • getCustomOrBuilder

        CustomHttpPatternOrBuilder getCustomOrBuilder()
         Custom pattern is used for defining custom verbs.
         
        .google.api.CustomHttpPattern custom = 8;
      • getBody

        java.lang.String getBody()
         The name of the request field whose value is mapped to the HTTP body, or
         `*` for mapping all fields not captured by the path pattern to the HTTP
         body. NOTE: the referred field must not be a repeated field and must be
         present at the top-level of 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 body, or
         `*` for mapping all fields not captured by the path pattern to the HTTP
         body. NOTE: the referred field must not be a repeated field and must be
         present at the top-level of request message type.
         
        string body = 7;
        Returns:
        The bytes for body.
      • 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;