HttpRule.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
    - - com.google.api.HttpRule.Builder

All Implemented Interfaces:: HttpRuleOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: HttpRule

public static final class HttpRule.Builder
extends GeneratedMessageV3.Builder<HttpRule.Builder>
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 | gRPC
 -----|-----
 `GET /v1/messages/123456`  | `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 | gRPC
 -----|-----
 `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
 `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 | gRPC
 -----|-----
 `PATCH /v1/messages/123456 { "text": "Hi!" }` | `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 | gRPC
 -----|-----
 `PATCH /v1/messages/123456 { "text": "Hi!" }` | `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 | gRPC
 -----|-----
 `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
 `GET /v1/users/me/messages/123456` | `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.
 Example:
     http:
       rules:
         # Selects a gRPC method and applies HttpRule to it.
         - 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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRule.Builder`	`addAdditionalBindings(HttpRule.Builder builderForValue)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addAdditionalBindings(HttpRule value)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addAdditionalBindings(int index, HttpRule.Builder builderForValue)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addAdditionalBindings(int index, HttpRule value)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addAdditionalBindingsBuilder()` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addAdditionalBindingsBuilder(int index)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addAllAdditionalBindings(java.lang.Iterable<? extends HttpRule> values)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`HttpRule`	`build()`
`HttpRule`	`buildPartial()`
`HttpRule.Builder`	`clear()`
`HttpRule.Builder`	`clearAdditionalBindings()` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`clearBody()` 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.
`HttpRule.Builder`	`clearCustom()` 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.
`HttpRule.Builder`	`clearDelete()` Maps to HTTP DELETE.
`HttpRule.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`HttpRule.Builder`	`clearGet()` Maps to HTTP GET.
`HttpRule.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`HttpRule.Builder`	`clearPatch()` Maps to HTTP PATCH.
`HttpRule.Builder`	`clearPattern()`
`HttpRule.Builder`	`clearPost()` Maps to HTTP POST.
`HttpRule.Builder`	`clearPut()` Maps to HTTP PUT.
`HttpRule.Builder`	`clearResponseBody()` Optional.
`HttpRule.Builder`	`clearSelector()` Selects a method to which this rule applies.
`HttpRule.Builder`	`clone()`
`HttpRule`	`getAdditionalBindings(int index)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`getAdditionalBindingsBuilder(int index)` Additional HTTP bindings for the selector.
`java.util.List<HttpRule.Builder>`	`getAdditionalBindingsBuilderList()` 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.
`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.
`CustomHttpPattern.Builder`	`getCustomBuilder()` 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.
`HttpRule`	`getDefaultInstanceForType()`
`java.lang.String`	`getDelete()` Maps to HTTP DELETE.
`ByteString`	`getDeleteBytes()` Maps to HTTP DELETE.
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getGet()` Maps to HTTP GET.
`ByteString`	`getGetBytes()` Maps to HTTP GET.
`java.lang.String`	`getPatch()` Maps to HTTP PATCH.
`ByteString`	`getPatchBytes()` Maps to HTTP PATCH.
`HttpRule.PatternCase`	`getPatternCase()`
`java.lang.String`	`getPost()` Maps to HTTP POST.
`ByteString`	`getPostBytes()` Maps to HTTP POST.
`java.lang.String`	`getPut()` Maps to HTTP PUT.
`ByteString`	`getPutBytes()` Maps to HTTP PUT.
`java.lang.String`	`getResponseBody()` Optional.
`ByteString`	`getResponseBodyBytes()` Optional.
`java.lang.String`	`getSelector()` Selects a method to which this rule applies.
`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.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`HttpRule.Builder`	`mergeCustom(CustomHttpPattern value)` 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.
`HttpRule.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`HttpRule.Builder`	`mergeFrom(HttpRule other)`
`HttpRule.Builder`	`mergeFrom(Message other)`
`HttpRule.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`HttpRule.Builder`	`removeAdditionalBindings(int index)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`setAdditionalBindings(int index, HttpRule.Builder builderForValue)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`setAdditionalBindings(int index, HttpRule value)` Additional HTTP bindings for the selector.
`HttpRule.Builder`	`setBody(java.lang.String value)` 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.
`HttpRule.Builder`	`setBodyBytes(ByteString value)` 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.
`HttpRule.Builder`	`setCustom(CustomHttpPattern.Builder builderForValue)` 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.
`HttpRule.Builder`	`setCustom(CustomHttpPattern value)` 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.
`HttpRule.Builder`	`setDelete(java.lang.String value)` Maps to HTTP DELETE.
`HttpRule.Builder`	`setDeleteBytes(ByteString value)` Maps to HTTP DELETE.
`HttpRule.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`HttpRule.Builder`	`setGet(java.lang.String value)` Maps to HTTP GET.
`HttpRule.Builder`	`setGetBytes(ByteString value)` Maps to HTTP GET.
`HttpRule.Builder`	`setPatch(java.lang.String value)` Maps to HTTP PATCH.
`HttpRule.Builder`	`setPatchBytes(ByteString value)` Maps to HTTP PATCH.
`HttpRule.Builder`	`setPost(java.lang.String value)` Maps to HTTP POST.
`HttpRule.Builder`	`setPostBytes(ByteString value)` Maps to HTTP POST.
`HttpRule.Builder`	`setPut(java.lang.String value)` Maps to HTTP PUT.
`HttpRule.Builder`	`setPutBytes(ByteString value)` Maps to HTTP PUT.
`HttpRule.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`HttpRule.Builder`	`setResponseBody(java.lang.String value)` Optional.
`HttpRule.Builder`	`setResponseBodyBytes(ByteString value)` Optional.
`HttpRule.Builder`	`setSelector(java.lang.String value)` Selects a method to which this rule applies.
`HttpRule.Builder`	`setSelectorBytes(ByteString value)` Selects a method to which this rule applies.
`HttpRule.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<HttpRule.Builder>

clear
```
public HttpRule.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<HttpRule.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<HttpRule.Builder>

getDefaultInstanceForType
```
public HttpRule getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public HttpRule build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public HttpRule buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public HttpRule.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<HttpRule.Builder>

setField

public HttpRule.Builder setField(Descriptors.FieldDescriptor field,
                                 java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<HttpRule.Builder>

clearField
```
public HttpRule.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<HttpRule.Builder>

clearOneof
```
public HttpRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<HttpRule.Builder>

setRepeatedField

public HttpRule.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<HttpRule.Builder>

addRepeatedField

public HttpRule.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                         java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<HttpRule.Builder>

mergeFrom
```
public HttpRule.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<HttpRule.Builder>

mergeFrom

public HttpRule.Builder mergeFrom(HttpRule other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<HttpRule.Builder>

mergeFrom

public HttpRule.Builder mergeFrom(CodedInputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<HttpRule.Builder>
Throws:: java.io.IOException

getPatternCase
```
public HttpRule.PatternCase getPatternCase()
```
Specified by:

getPatternCase in interface HttpRuleOrBuilder

clearPattern

public HttpRule.Builder clearPattern()

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

getSelectorBytes

public 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

setSelector

public HttpRule.Builder setSelector(java.lang.String value)

 Selects a method to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

string selector = 1;

clearSelector

public HttpRule.Builder clearSelector()

 Selects a method to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

string selector = 1;

setSelectorBytes

public HttpRule.Builder setSelectorBytes(ByteString value)

 Selects a method to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

string selector = 1;

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

getGetBytes

public ByteString getGetBytes()

 Maps to HTTP GET. Used for listing and getting information about
 resources.

string get = 2;

Specified by:: getGetBytes in interface HttpRuleOrBuilder

setGet

public HttpRule.Builder setGet(java.lang.String value)

 Maps to HTTP GET. Used for listing and getting information about
 resources.

string get = 2;

clearGet

public HttpRule.Builder clearGet()

 Maps to HTTP GET. Used for listing and getting information about
 resources.

string get = 2;

setGetBytes

public HttpRule.Builder setGetBytes(ByteString value)

 Maps to HTTP GET. Used for listing and getting information about
 resources.

string get = 2;

getPut

public java.lang.String getPut()

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

Specified by:: getPut in interface HttpRuleOrBuilder

getPutBytes

public ByteString getPutBytes()

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

Specified by:: getPutBytes in interface HttpRuleOrBuilder

setPut

public HttpRule.Builder setPut(java.lang.String value)

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

clearPut

public HttpRule.Builder clearPut()

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

setPutBytes

public HttpRule.Builder setPutBytes(ByteString value)

 Maps to HTTP PUT. Used for replacing a resource.

string put = 3;

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

getPostBytes

public ByteString getPostBytes()

 Maps to HTTP POST. Used for creating a resource or performing an action.

string post = 4;

Specified by:: getPostBytes in interface HttpRuleOrBuilder

setPost

public HttpRule.Builder setPost(java.lang.String value)

 Maps to HTTP POST. Used for creating a resource or performing an action.

string post = 4;

clearPost

public HttpRule.Builder clearPost()

 Maps to HTTP POST. Used for creating a resource or performing an action.

string post = 4;

setPostBytes

public HttpRule.Builder setPostBytes(ByteString value)

 Maps to HTTP POST. Used for creating a resource or performing an action.

string post = 4;

getDelete

public java.lang.String getDelete()

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

Specified by:: getDelete in interface HttpRuleOrBuilder

getDeleteBytes

public ByteString getDeleteBytes()

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

Specified by:: getDeleteBytes in interface HttpRuleOrBuilder

setDelete

public HttpRule.Builder setDelete(java.lang.String value)

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

clearDelete

public HttpRule.Builder clearDelete()

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

setDeleteBytes

public HttpRule.Builder setDeleteBytes(ByteString value)

 Maps to HTTP DELETE. Used for deleting a resource.

string delete = 5;

getPatch

public java.lang.String getPatch()

 Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

Specified by:: getPatch in interface HttpRuleOrBuilder

getPatchBytes

public ByteString getPatchBytes()

 Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

Specified by:: getPatchBytes in interface HttpRuleOrBuilder

setPatch

public HttpRule.Builder setPatch(java.lang.String value)

 Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

clearPatch

public HttpRule.Builder clearPatch()

 Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

setPatchBytes

public HttpRule.Builder setPatchBytes(ByteString value)

 Maps to HTTP PATCH. Used for updating a resource.

string patch = 6;

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

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

setCustom

public HttpRule.Builder setCustom(CustomHttpPattern value)

 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;

setCustom

public HttpRule.Builder setCustom(CustomHttpPattern.Builder builderForValue)

 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;

mergeCustom

public HttpRule.Builder mergeCustom(CustomHttpPattern value)

 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;

clearCustom

public HttpRule.Builder clearCustom()

 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;

getCustomBuilder

public CustomHttpPattern.Builder getCustomBuilder()

 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

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

getBodyBytes

public 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

setBody

public HttpRule.Builder setBody(java.lang.String value)

 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;

clearBody

public HttpRule.Builder clearBody()

 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;

setBodyBytes

public HttpRule.Builder setBodyBytes(ByteString value)

 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

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

getResponseBodyBytes

public 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

setResponseBody

public HttpRule.Builder setResponseBody(java.lang.String value)

 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;

clearResponseBody

public HttpRule.Builder clearResponseBody()

 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;

setResponseBodyBytes

public HttpRule.Builder setResponseBodyBytes(ByteString value)

 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;