Class HttpRule

  • All Implemented Interfaces:
    HttpRuleOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class HttpRule
    extends com.google.protobuf.GeneratedMessageV3
    implements HttpRuleOrBuilder
     gRPC Transcoding
    
     gRPC Transcoding is a feature for mapping between a gRPC method and one or
     more HTTP REST endpoints. It allows developers to build a single API service
     that supports both gRPC APIs and REST APIs. Many systems, including [Google
     APIs](https://github.com/googleapis/googleapis),
     [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
     Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
     and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
     and use it for large scale production services.
    
     `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
     how different portions of the gRPC request message are mapped to the URL
     path, URL query parameters, and HTTP request body. It also controls how the
     gRPC response message is mapped to the HTTP response body. `HttpRule` is
     typically specified as an `google.api.http` annotation on the gRPC method.
    
     Each mapping specifies a URL path template and an HTTP method. The path
     template may refer to one or more fields in the gRPC request message, as long
     as each field is a non-repeated field with a primitive (non-message) type.
     The path template controls how fields of the request message are mapped to
     the URL path.
    
     Example:
    
         service Messaging {
           rpc GetMessage(GetMessageRequest) returns (Message) {
             option (google.api.http) = {
                 get: "/v1/{name=messages/*}"
             };
           }
         }
         message GetMessageRequest {
           string name = 1; // Mapped to URL path.
         }
         message Message {
           string text = 1; // The resource content.
         }
    
     This enables an HTTP REST to gRPC mapping as below:
    
     - HTTP: `GET /v1/messages/123456`
     - gRPC: `GetMessage(name: "messages/123456")`
    
     Any fields in the request message which are not bound by the path template
     automatically become HTTP query parameters if there is no HTTP request body.
     For example:
    
         service Messaging {
           rpc GetMessage(GetMessageRequest) returns (Message) {
             option (google.api.http) = {
                 get:"/v1/messages/{message_id}"
             };
           }
         }
         message GetMessageRequest {
           message SubMessage {
             string subfield = 1;
           }
           string message_id = 1; // Mapped to URL path.
           int64 revision = 2;    // Mapped to URL query parameter `revision`.
           SubMessage sub = 3;    // Mapped to URL query parameter `sub.subfield`.
         }
    
     This enables a HTTP JSON to RPC mapping as below:
    
     - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo`
     - gRPC: `GetMessage(message_id: "123456" revision: 2 sub:
     SubMessage(subfield: "foo"))`
    
     Note that fields which are mapped to URL query parameters must have a
     primitive type or a repeated primitive type or a non-repeated message type.
     In the case of a repeated type, the parameter can be repeated in the URL
     as `...?param=A&param=B`. In the case of a message type, each field of the
     message is mapped to a separate parameter, such as
     `...?foo.a=A&foo.b=B&foo.c=C`.
    
     For HTTP methods that allow a request body, the `body` field
     specifies the mapping. Consider a REST update method on the
     message resource collection:
    
         service Messaging {
           rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
             option (google.api.http) = {
               patch: "/v1/messages/{message_id}"
               body: "message"
             };
           }
         }
         message UpdateMessageRequest {
           string message_id = 1; // mapped to the URL
           Message message = 2;   // mapped to the body
         }
    
     The following HTTP JSON to RPC mapping is enabled, where the
     representation of the JSON in the request body is determined by
     protos JSON encoding:
    
     - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }`
     - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
    
     The special name `*` can be used in the body mapping to define that
     every field not bound by the path template should be mapped to the
     request body.  This enables the following alternative definition of
     the update method:
    
         service Messaging {
           rpc UpdateMessage(Message) returns (Message) {
             option (google.api.http) = {
               patch: "/v1/messages/{message_id}"
               body: "*"
             };
           }
         }
         message Message {
           string message_id = 1;
           string text = 2;
         }
    
    
     The following HTTP JSON to RPC mapping is enabled:
    
     - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }`
     - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")`
    
     Note that when using `*` in the body mapping, it is not possible to
     have HTTP parameters, as all fields not bound by the path end in
     the body. This makes this option more rarely used in practice when
     defining REST APIs. The common usage of `*` is in custom methods
     which don't use the URL at all for transferring data.
    
     It is possible to define multiple HTTP methods for one RPC by using
     the `additional_bindings` option. Example:
    
         service Messaging {
           rpc GetMessage(GetMessageRequest) returns (Message) {
             option (google.api.http) = {
               get: "/v1/messages/{message_id}"
               additional_bindings {
                 get: "/v1/users/{user_id}/messages/{message_id}"
               }
             };
           }
         }
         message GetMessageRequest {
           string message_id = 1;
           string user_id = 2;
         }
    
     This enables the following two alternative HTTP JSON to RPC mappings:
    
     - HTTP: `GET /v1/messages/123456`
     - gRPC: `GetMessage(message_id: "123456")`
    
     - HTTP: `GET /v1/users/me/messages/123456`
     - gRPC: `GetMessage(user_id: "me" message_id: "123456")`
    
     Rules for HTTP mapping
    
     1. Leaf request fields (recursive expansion nested messages in the request
        message) are classified into three categories:
        - Fields referred by the path template. They are passed via the URL path.
        - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They
        are passed via the HTTP
          request body.
        - All other fields are passed via the URL query parameters, and the
          parameter name is the field path in the request message. A repeated
          field can be represented as multiple query parameters under the same
          name.
      2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL
      query parameter, all fields
         are passed via URL path and HTTP request body.
      3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP
      request body, all
         fields are passed via URL path and URL query parameters.
    
     Path template syntax
    
         Template = "/" Segments [ Verb ] ;
         Segments = Segment { "/" Segment } ;
         Segment  = "*" | "**" | LITERAL | Variable ;
         Variable = "{" FieldPath [ "=" Segments ] "}" ;
         FieldPath = IDENT { "." IDENT } ;
         Verb     = ":" LITERAL ;
    
     The syntax `*` matches a single URL path segment. The syntax `**` matches
     zero or more URL path segments, which must be the last part of the URL path
     except the `Verb`.
    
     The syntax `Variable` matches part of the URL path as specified by its
     template. A variable template must not contain other variables. If a variable
     matches a single path segment, its template may be omitted, e.g. `{var}`
     is equivalent to `{var=*}`.
    
     The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
     contains any reserved character, such characters should be percent-encoded
     before the matching.
    
     If a variable contains exactly one path segment, such as `"{var}"` or
     `"{var=*}"`, when such a variable is expanded into a URL path on the client
     side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
     server side does the reverse decoding. Such variables show up in the
     [Discovery
     Document](https://developers.google.com/discovery/v1/reference/apis) as
     `{var}`.
    
     If a variable contains multiple path segments, such as `"{var=foo/*}"`
     or `"{var=**}"`, when such a variable is expanded into a URL path on the
     client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
     The server side does the reverse decoding, except "%2F" and "%2f" are left
     unchanged. Such variables show up in the
     [Discovery
     Document](https://developers.google.com/discovery/v1/reference/apis) as
     `{+var}`.
    
     Using gRPC API Service Configuration
    
     gRPC API Service Configuration (service config) is a configuration language
     for configuring a gRPC service to become a user-facing product. The
     service config is simply the YAML representation of the `google.api.Service`
     proto message.
    
     As an alternative to annotating your proto file, you can configure gRPC
     transcoding in your service config YAML files. You do this by specifying a
     `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
     effect as the proto annotation. This can be particularly useful if you
     have a proto that is reused in multiple services. Note that any transcoding
     specified in the service config will override any matching transcoding
     configuration in the proto.
    
     The following example selects a gRPC method and applies an `HttpRule` to it:
    
         http:
           rules:
             - selector: example.v1.Messaging.GetMessage
               get: /v1/messages/{message_id}/{sub.subfield}
    
     Special notes
    
     When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
     proto to JSON conversion must follow the [proto3
     specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
    
     While the single segment variable follows the semantics of
     [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
     Expansion, the multi segment variable **does not** follow RFC 6570 Section
     3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
     does not expand special characters like `?` and `#`, which would lead
     to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
     for multi segment variables.
    
     The path variables **must not** refer to any repeated or mapped field,
     because client libraries are not capable of handling such variable expansion.
    
     The path variables **must not** capture the leading "/" character. The reason
     is that the most common use case "{var}" does not capture the leading "/"
     character. For consistency, all path variables must share the same behavior.
    
     Repeated message fields must not be mapped to URL query parameters, because
     no client library can support such complicated mapping.
    
     If an API needs to use a JSON array for request or response body, it can map
     the request or response body to a repeated field. However, some gRPC
     Transcoding implementations may not support this feature.
     
    Protobuf type google.api.HttpRule
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HttpRule.Builder
      gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints.
      static class  HttpRule.PatternCase  
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends java.lang.Object>
      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      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.
      static HttpRule getDefaultInstance()  
      HttpRule getDefaultInstanceForType()  
      java.lang.String getDelete()
      Maps to HTTP DELETE.
      com.google.protobuf.ByteString getDeleteBytes()
      Maps to HTTP DELETE.
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getGet()
      Maps to HTTP GET.
      com.google.protobuf.ByteString getGetBytes()
      Maps to HTTP GET.
      com.google.protobuf.Parser<HttpRule> getParserForType()  
      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.
      int getSerializedSize()  
      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.
      int hashCode()  
      boolean hasPatch()
      Maps to HTTP PATCH.
      boolean hasPost()
      Maps to HTTP POST.
      boolean hasPut()
      Maps to HTTP PUT.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static HttpRule.Builder newBuilder()  
      static HttpRule.Builder newBuilder​(HttpRule prototype)  
      HttpRule.Builder newBuilderForType()  
      protected HttpRule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static HttpRule parseDelimitedFrom​(java.io.InputStream input)  
      static HttpRule parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HttpRule parseFrom​(byte[] data)  
      static HttpRule parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HttpRule parseFrom​(com.google.protobuf.ByteString data)  
      static HttpRule parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HttpRule parseFrom​(com.google.protobuf.CodedInputStream input)  
      static HttpRule parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HttpRule parseFrom​(java.io.InputStream input)  
      static HttpRule parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static HttpRule parseFrom​(java.nio.ByteBuffer data)  
      static HttpRule parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<HttpRule> parser()  
      HttpRule.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType
      • Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

        extensionsAreInitialized, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Overrides:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • getSelector

        public 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;
        Specified by:
        getSelector in interface HttpRuleOrBuilder
        Returns:
        The selector.
      • getSelectorBytes

        public 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;
        Specified by:
        getSelectorBytes in interface HttpRuleOrBuilder
        Returns:
        The bytes for selector.
      • hasGet

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

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

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

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

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

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

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

        public java.lang.String getPost()
         Maps to HTTP POST. Used for creating a resource or performing an action.
         
        string post = 4;
        Specified by:
        getPost in interface HttpRuleOrBuilder
        Returns:
        The post.
      • getPostBytes

        public com.google.protobuf.ByteString getPostBytes()
         Maps to HTTP POST. Used for creating a resource or performing an action.
         
        string post = 4;
        Specified by:
        getPostBytes in interface HttpRuleOrBuilder
        Returns:
        The bytes for post.
      • hasDelete

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

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

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

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

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

        public com.google.protobuf.ByteString getPatchBytes()
         Maps to HTTP PATCH. Used for updating a resource.
         
        string patch = 6;
        Specified by:
        getPatchBytes in interface HttpRuleOrBuilder
        Returns:
        The bytes for patch.
      • hasCustom

        public 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;
        Specified by:
        hasCustom in interface HttpRuleOrBuilder
        Returns:
        Whether the custom field is set.
      • getCustom

        public 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;
        Specified by:
        getCustom in interface HttpRuleOrBuilder
        Returns:
        The custom.
      • getCustomOrBuilder

        public 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;
        Specified by:
        getCustomOrBuilder in interface HttpRuleOrBuilder
      • getBody

        public 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;
        Specified by:
        getBody in interface HttpRuleOrBuilder
        Returns:
        The body.
      • getBodyBytes

        public 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;
        Specified by:
        getBodyBytes in interface HttpRuleOrBuilder
        Returns:
        The bytes for body.
      • getResponseBody

        public 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;
        Specified by:
        getResponseBody in interface HttpRuleOrBuilder
        Returns:
        The responseBody.
      • getResponseBodyBytes

        public 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;
        Specified by:
        getResponseBodyBytes in interface HttpRuleOrBuilder
        Returns:
        The bytes for responseBody.
      • getAdditionalBindingsList

        public 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;
        Specified by:
        getAdditionalBindingsList in interface HttpRuleOrBuilder
      • getAdditionalBindingsOrBuilderList

        public 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;
        Specified by:
        getAdditionalBindingsOrBuilderList in interface HttpRuleOrBuilder
      • getAdditionalBindingsCount

        public 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;
        Specified by:
        getAdditionalBindingsCount in interface HttpRuleOrBuilder
      • getAdditionalBindings

        public 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;
        Specified by:
        getAdditionalBindings in interface HttpRuleOrBuilder
      • getAdditionalBindingsOrBuilder

        public 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;
        Specified by:
        getAdditionalBindingsOrBuilder in interface HttpRuleOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static HttpRule parseFrom​(java.nio.ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HttpRule parseFrom​(java.nio.ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HttpRule parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HttpRule parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HttpRule parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HttpRule parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static HttpRule parseFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static HttpRule parseFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static HttpRule parseDelimitedFrom​(java.io.InputStream input)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static HttpRule parseDelimitedFrom​(java.io.InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static HttpRule parseFrom​(com.google.protobuf.CodedInputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static HttpRule parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

        public HttpRule.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public HttpRule.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected HttpRule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static HttpRule getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<HttpRule> parser()
      • getParserForType

        public com.google.protobuf.Parser<HttpRule> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessage
      • getDefaultInstanceForType

        public HttpRule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder