程序包 com.google.api

# 类 HttpRule.Builder

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

所有已实现的接口:
  `HttpRuleOrBuilder`, `com.google.protobuf.Message.Builder`, `com.google.protobuf.MessageLite.Builder`, `com.google.protobuf.MessageLiteOrBuilder`, `com.google.protobuf.MessageOrBuilder`, `Cloneable`

封闭类:
  HttpRule

public static final class HttpRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder> implements HttpRuleOrBuilder

     `HttpRule` defines the mapping of an RPC method to one or more HTTP
     REST API methods. The mapping specifies how different portions of the RPC
     request message are mapped to URL path, URL query parameters, and
     HTTP request body. The mapping is typically specified as an
     `google.api.http` annotation on the RPC method,
     see "google/api/annotations.proto" for details.
     The mapping consists of a field specifying the path template and
     method kind.  The path template can refer to fields in the request
     message, as in the example below which describes a REST GET
     operation on a resource collection of messages:
         service Messaging {
           rpc GetMessage(GetMessageRequest) returns (Message) {
             option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
           }
         }
         message GetMessageRequest {
           message SubMessage {
             string subfield = 1;
           }
           string message_id = 1; // mapped to the URL
           SubMessage sub = 2;    // `sub.subfield` is url-mapped
         }
         message Message {
           string text = 1; // content of the resource
         }
     The same http annotation can alternatively be expressed inside the
     `GRPC API Configuration` YAML file.
         http:
           rules:
             - selector: <proto_package_name>.Messaging.GetMessage
               get: /v1/messages/{message_id}/{sub.subfield}
     This definition enables an automatic, bidrectional mapping of HTTP
     JSON to RPC. Example:
     HTTP | RPC
     -----|-----
     `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
     In general, not only fields but also field paths can be referenced
     from a path pattern. Fields mapped to the path pattern cannot be
     repeated and must have a primitive (non-message) type.
     Any fields in the request message which are not bound by the path
     pattern automatically become (optional) HTTP query
     parameters. Assume the following definition of the request message:
         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 the URL
           int64 revision = 2;    // becomes a parameter
           SubMessage sub = 3;    // `sub.subfield` becomes a parameter
         }
     This enables a HTTP JSON to RPC mapping as below:
     HTTP | RPC
     -----|-----
     `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 HTTP parameters must have a
     primitive type or a repeated primitive type. Message types are not
     allowed. In the case of a repeated type, the parameter can be
     repeated in the URL, as in `...?param=A&param=B`.
     For HTTP method kinds which 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) = {
               put: "/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 | RPC
     -----|-----
     `PUT /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) = {
               put: "/v1/messages/{message_id}"
               body: "*"
             };
           }
         }
         message Message {
           string message_id = 1;
           string text = 2;
         }
     The following HTTP JSON to RPC mapping is enabled:
     HTTP | RPC
     -----|-----
     `PUT /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 of
     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 | RPC
     -----|-----
     `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
     The rules for mapping HTTP path, query parameters, and body fields
     to the request message are as follows:
     1. The `body` field specifies either `*` or a field path, or is
        omitted. If omitted, it indicates there is no HTTP request body.
     2. Leaf fields (recursive expansion of nested messages in the
        request) can be classified into three types:
         (a) Matched in the URL template.
         (b) Covered by body (if body is `*`, everything except (a) fields;
             else everything under the body field)
         (c) All other fields.
     3. URL query parameters found in the HTTP request are mapped to (c) fields.
     4. Any body sent with an HTTP request can contain only (b) fields.
     The syntax of the path template is as follows:
         Template = "/" Segments [ Verb ] ;
         Segments = Segment { "/" Segment } ;
         Segment  = "*" | "**" | LITERAL | Variable ;
         Variable = "{" FieldPath [ "=" Segments ] "}" ;
         FieldPath = IDENT { "." IDENT } ;
         Verb     = ":" LITERAL ;
     The syntax `*` matches a single path segment. The syntax `**` matches zero
     or more path segments, which must be the last part of the path except the
     `Verb`. The syntax `LITERAL` matches literal text in the path.
     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=*}`.
     If a variable contains exactly one path segment, such as `"{var}"` or
     `"{var=*}"`, when such a variable is expanded into a URL path, all characters
     except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the
     Discovery Document as `{var}`.
     If a variable contains one or more path segments, such as `"{var=foo/*}"`
     or `"{var=**}"`, when such a variable is expanded into a URL path, all
     characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
     show up in the Discovery Document as `{+var}`.
     NOTE: While the single segment variable matches the semantics of
     [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
     Simple String Expansion, the multi segment variable **does not** match
     RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion
     does not expand special characters like `?` and `#`, which would lead
     to invalid URLs.
     NOTE: the field paths in variables and in the `body` must not refer to
     repeated fields or map fields.

Protobuf type `google.api.HttpRule`

- ## 方法概要

  修饰符和类型
  方法
  说明
  `HttpRule.Builder`
  `addAdditionalBindings​(int index, 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​(HttpRule value)`
  Additional HTTP bindings for the selector.
  `HttpRule.Builder`
  `addAdditionalBindings​(HttpRule.Builder builderForValue)`
  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​(Iterable<? extends HttpRule> values)`
  Additional HTTP bindings for the selector.
  `HttpRule.Builder`
  `addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, 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 body, or `*` for mapping all fields not captured by the path pattern to the HTTP 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()`
  Used for deleting a resource.
  `HttpRule.Builder`
  `clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)`
  `HttpRule.Builder`
  `clearGet()`
  Used for listing and getting information about resources.
  `HttpRule.Builder`
  `clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
  `HttpRule.Builder`
  `clearPatch()`
  Used for updating a resource.
  `HttpRule.Builder`
  `clearPattern()`
  `HttpRule.Builder`
  `clearPost()`
  Used for creating a resource.
  `HttpRule.Builder`
  `clearPut()`
  Used for updating a resource.
  `HttpRule.Builder`
  `clearResponseBody()`
  Optional.
  `HttpRule.Builder`
  `clearSelector()`
  Selects methods 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.
  `List<HttpRule.Builder>`
  `getAdditionalBindingsBuilderList()`
  Additional HTTP bindings for the selector.
  `int`
  `getAdditionalBindingsCount()`
  Additional HTTP bindings for the selector.
  `List<HttpRule>`
  `getAdditionalBindingsList()`
  Additional HTTP bindings for the selector.
  `HttpRuleOrBuilder`
  `getAdditionalBindingsOrBuilder​(int index)`
  Additional HTTP bindings for the selector.
  `List<? extends HttpRuleOrBuilder>`
  `getAdditionalBindingsOrBuilderList()`
  Additional HTTP bindings for the selector.
  `String`
  `getBody()`
  The name of the request field whose value is mapped to the HTTP 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()`
  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()`
  `String`
  `getDelete()`
  Used for deleting a resource.
  `com.google.protobuf.ByteString`
  `getDeleteBytes()`
  Used for deleting a resource.
  `static com.google.protobuf.Descriptors.Descriptor`
  `getDescriptor()`
  `com.google.protobuf.Descriptors.Descriptor`
  `getDescriptorForType()`
  `String`
  `getGet()`
  Used for listing and getting information about resources.
  `com.google.protobuf.ByteString`
  `getGetBytes()`
  Used for listing and getting information about resources.
  `String`
  `getPatch()`
  Used for updating a resource.
  `com.google.protobuf.ByteString`
  `getPatchBytes()`
  Used for updating a resource.
  `HttpRule.PatternCase`
  `getPatternCase()`
  `String`
  `getPost()`
  Used for creating a resource.
  `com.google.protobuf.ByteString`
  `getPostBytes()`
  Used for creating a resource.
  `String`
  `getPut()`
  Used for updating a resource.
  `com.google.protobuf.ByteString`
  `getPutBytes()`
  Used for updating a resource.
  `String`
  `getResponseBody()`
  Optional.
  `com.google.protobuf.ByteString`
  `getResponseBodyBytes()`
  Optional.
  `String`
  `getSelector()`
  Selects methods to which this rule applies.
  `com.google.protobuf.ByteString`
  `getSelectorBytes()`
  Selects methods 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()`
  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.
  `protected com.google.protobuf.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​(HttpRule other)`
  `HttpRule.Builder`
  `mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `HttpRule.Builder`
  `mergeFrom​(com.google.protobuf.Message other)`
  `HttpRule.Builder`
  `mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)`
  `HttpRule.Builder`
  `removeAdditionalBindings​(int index)`
  Additional HTTP bindings for the selector.
  `HttpRule.Builder`
  `setAdditionalBindings​(int index, HttpRule value)`
  Additional HTTP bindings for the selector.
  `HttpRule.Builder`
  `setAdditionalBindings​(int index, HttpRule.Builder builderForValue)`
  Additional HTTP bindings for the selector.
  `HttpRule.Builder`
  `setBody​(String value)`
  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.
  `HttpRule.Builder`
  `setBodyBytes​(com.google.protobuf.ByteString value)`
  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.
  `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`
  `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`
  `setDelete​(String value)`
  Used for deleting a resource.
  `HttpRule.Builder`
  `setDeleteBytes​(com.google.protobuf.ByteString value)`
  Used for deleting a resource.
  `HttpRule.Builder`
  `setField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
  `HttpRule.Builder`
  `setGet​(String value)`
  Used for listing and getting information about resources.
  `HttpRule.Builder`
  `setGetBytes​(com.google.protobuf.ByteString value)`
  Used for listing and getting information about resources.
  `HttpRule.Builder`
  `setPatch​(String value)`
  Used for updating a resource.
  `HttpRule.Builder`
  `setPatchBytes​(com.google.protobuf.ByteString value)`
  Used for updating a resource.
  `HttpRule.Builder`
  `setPost​(String value)`
  Used for creating a resource.
  `HttpRule.Builder`
  `setPostBytes​(com.google.protobuf.ByteString value)`
  Used for creating a resource.
  `HttpRule.Builder`
  `setPut​(String value)`
  Used for updating a resource.
  `HttpRule.Builder`
  `setPutBytes​(com.google.protobuf.ByteString value)`
  Used for updating a resource.
  `HttpRule.Builder`
  `setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
  `HttpRule.Builder`
  `setResponseBody​(String value)`
  Optional.
  `HttpRule.Builder`
  `setResponseBodyBytes​(com.google.protobuf.ByteString value)`
  Optional.
  `HttpRule.Builder`
  `setSelector​(String value)`
  Selects methods to which this rule applies.
  `HttpRule.Builder`
  `setSelectorBytes​(com.google.protobuf.ByteString value)`
  Selects methods to which this rule applies.
  `HttpRule.Builder`
  `setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)`

  ### 从类继承的方法 com.google.protobuf.GeneratedMessageV3.Builder

  `getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3`

  ### 从类继承的方法 com.google.protobuf.AbstractMessage.Builder

  `findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString`

  ### 从类继承的方法 com.google.protobuf.AbstractMessageLite.Builder

  `addAll, addAll, mergeFrom, newUninitializedMessageException`

  ### 从类继承的方法 java.lang.Object

  `equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

  ### 从接口继承的方法 com.google.protobuf.MessageLite.Builder

  `mergeFrom`

  ### 从接口继承的方法 com.google.protobuf.MessageOrBuilder

  `findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof`

- ## 方法详细资料

  - ### getDescriptor

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

  - ### internalGetFieldAccessorTable

    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    指定者:
      `internalGetFieldAccessorTable` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### clear

    public HttpRule.Builder clear()
    指定者:
      `clear` 在接口中 `com.google.protobuf.Message.Builder`
    指定者:
      `clear` 在接口中 `com.google.protobuf.MessageLite.Builder`
    覆盖:
      `clear` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### getDescriptorForType

    public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
    指定者:
      `getDescriptorForType` 在接口中 `com.google.protobuf.Message.Builder`
    指定者:
      `getDescriptorForType` 在接口中 `com.google.protobuf.MessageOrBuilder`
    覆盖:
      `getDescriptorForType` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### getDefaultInstanceForType

    public HttpRule getDefaultInstanceForType()
    指定者:
      `getDefaultInstanceForType` 在接口中 `com.google.protobuf.MessageLiteOrBuilder`
    指定者:
      `getDefaultInstanceForType` 在接口中 `com.google.protobuf.MessageOrBuilder`

  - ### build

    public HttpRule build()
    指定者:
      `build` 在接口中 `com.google.protobuf.Message.Builder`
    指定者:
      `build` 在接口中 `com.google.protobuf.MessageLite.Builder`

  - ### buildPartial

    public HttpRule buildPartial()
    指定者:
      `buildPartial` 在接口中 `com.google.protobuf.Message.Builder`
    指定者:
      `buildPartial` 在接口中 `com.google.protobuf.MessageLite.Builder`

  - ### clone

    public HttpRule.Builder clone()
    指定者:
      `clone` 在接口中 `com.google.protobuf.Message.Builder`
    指定者:
      `clone` 在接口中 `com.google.protobuf.MessageLite.Builder`
    覆盖:
      `clone` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### setField

    public HttpRule.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
    指定者:
      `setField` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `setField` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### clearField

    public HttpRule.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
    指定者:
      `clearField` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `clearField` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### clearOneof

    public HttpRule.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
    指定者:
      `clearOneof` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `clearOneof` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### setRepeatedField

    public HttpRule.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
    指定者:
      `setRepeatedField` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `setRepeatedField` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### addRepeatedField

    public HttpRule.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
    指定者:
      `addRepeatedField` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `addRepeatedField` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### mergeFrom

    public HttpRule.Builder mergeFrom​(com.google.protobuf.Message other)
    指定者:
      `mergeFrom` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `mergeFrom` 在类中 `com.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>`

  - ### mergeFrom

    public HttpRule.Builder mergeFrom​(HttpRule other)

  - ### isInitialized

    public final boolean isInitialized()
    指定者:
      `isInitialized` 在接口中 `com.google.protobuf.MessageLiteOrBuilder`
    覆盖:
      `isInitialized` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### mergeFrom

    public HttpRule.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
    指定者:
      `mergeFrom` 在接口中 `com.google.protobuf.Message.Builder`
    指定者:
      `mergeFrom` 在接口中 `com.google.protobuf.MessageLite.Builder`
    覆盖:
      `mergeFrom` 在类中 `com.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>`
    抛出:
      `IOException`

  - ### getPatternCase

    public HttpRule.PatternCase getPatternCase()
    指定者:
      `getPatternCase` 在接口中 `HttpRuleOrBuilder`

  - ### clearPattern

    public HttpRule.Builder clearPattern()

  - ### getSelector

    public String getSelector()

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

    `string selector = 1;`
    指定者:
      `getSelector` 在接口中 `HttpRuleOrBuilder`
    返回:
      The selector.

  - ### getSelectorBytes

    public 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;`
    指定者:
      `getSelectorBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for selector.

  - ### setSelector

    public HttpRule.Builder setSelector​(String value)

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

    `string selector = 1;`
    参数:
      `value` - The selector to set.
    返回:
      This builder for chaining.

  - ### clearSelector

    public HttpRule.Builder clearSelector()

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

    `string selector = 1;`
    返回:
      This builder for chaining.

  - ### setSelectorBytes

    public HttpRule.Builder setSelectorBytes​(com.google.protobuf.ByteString value)

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

    `string selector = 1;`
    参数:
      `value` - The bytes for selector to set.
    返回:
      This builder for chaining.

  - ### hasGet

    public boolean hasGet()

         Used for listing and getting information about resources.

    `string get = 2;`
    指定者:
      `hasGet` 在接口中 `HttpRuleOrBuilder`
    返回:
      Whether the get field is set.

  - ### getGet

    public String getGet()

         Used for listing and getting information about resources.

    `string get = 2;`
    指定者:
      `getGet` 在接口中 `HttpRuleOrBuilder`
    返回:
      The get.

  - ### getGetBytes

    public com.google.protobuf.ByteString getGetBytes()

         Used for listing and getting information about resources.

    `string get = 2;`
    指定者:
      `getGetBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for get.

  - ### setGet

    public HttpRule.Builder setGet​(String value)

         Used for listing and getting information about resources.

    `string get = 2;`
    参数:
      `value` - The get to set.
    返回:
      This builder for chaining.

  - ### clearGet

    public HttpRule.Builder clearGet()

         Used for listing and getting information about resources.

    `string get = 2;`
    返回:
      This builder for chaining.

  - ### setGetBytes

    public HttpRule.Builder setGetBytes​(com.google.protobuf.ByteString value)

         Used for listing and getting information about resources.

    `string get = 2;`
    参数:
      `value` - The bytes for get to set.
    返回:
      This builder for chaining.

  - ### hasPut

    public boolean hasPut()

         Used for updating a resource.

    `string put = 3;`
    指定者:
      `hasPut` 在接口中 `HttpRuleOrBuilder`
    返回:
      Whether the put field is set.

  - ### getPut

    public String getPut()

         Used for updating a resource.

    `string put = 3;`
    指定者:
      `getPut` 在接口中 `HttpRuleOrBuilder`
    返回:
      The put.

  - ### getPutBytes

    public com.google.protobuf.ByteString getPutBytes()

         Used for updating a resource.

    `string put = 3;`
    指定者:
      `getPutBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for put.

  - ### setPut

    public HttpRule.Builder setPut​(String value)

         Used for updating a resource.

    `string put = 3;`
    参数:
      `value` - The put to set.
    返回:
      This builder for chaining.

  - ### clearPut

    public HttpRule.Builder clearPut()

         Used for updating a resource.

    `string put = 3;`
    返回:
      This builder for chaining.

  - ### setPutBytes

    public HttpRule.Builder setPutBytes​(com.google.protobuf.ByteString value)

         Used for updating a resource.

    `string put = 3;`
    参数:
      `value` - The bytes for put to set.
    返回:
      This builder for chaining.

  - ### hasPost

    public boolean hasPost()

         Used for creating a resource.

    `string post = 4;`
    指定者:
      `hasPost` 在接口中 `HttpRuleOrBuilder`
    返回:
      Whether the post field is set.

  - ### getPost

    public String getPost()

         Used for creating a resource.

    `string post = 4;`
    指定者:
      `getPost` 在接口中 `HttpRuleOrBuilder`
    返回:
      The post.

  - ### getPostBytes

    public com.google.protobuf.ByteString getPostBytes()

         Used for creating a resource.

    `string post = 4;`
    指定者:
      `getPostBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for post.

  - ### setPost

    public HttpRule.Builder setPost​(String value)

         Used for creating a resource.

    `string post = 4;`
    参数:
      `value` - The post to set.
    返回:
      This builder for chaining.

  - ### clearPost

    public HttpRule.Builder clearPost()

         Used for creating a resource.

    `string post = 4;`
    返回:
      This builder for chaining.

  - ### setPostBytes

    public HttpRule.Builder setPostBytes​(com.google.protobuf.ByteString value)

         Used for creating a resource.

    `string post = 4;`
    参数:
      `value` - The bytes for post to set.
    返回:
      This builder for chaining.

  - ### hasDelete

    public boolean hasDelete()

         Used for deleting a resource.

    `string delete = 5;`
    指定者:
      `hasDelete` 在接口中 `HttpRuleOrBuilder`
    返回:
      Whether the delete field is set.

  - ### getDelete

    public String getDelete()

         Used for deleting a resource.

    `string delete = 5;`
    指定者:
      `getDelete` 在接口中 `HttpRuleOrBuilder`
    返回:
      The delete.

  - ### getDeleteBytes

    public com.google.protobuf.ByteString getDeleteBytes()

         Used for deleting a resource.

    `string delete = 5;`
    指定者:
      `getDeleteBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for delete.

  - ### setDelete

    public HttpRule.Builder setDelete​(String value)

         Used for deleting a resource.

    `string delete = 5;`
    参数:
      `value` - The delete to set.
    返回:
      This builder for chaining.

  - ### clearDelete

    public HttpRule.Builder clearDelete()

         Used for deleting a resource.

    `string delete = 5;`
    返回:
      This builder for chaining.

  - ### setDeleteBytes

    public HttpRule.Builder setDeleteBytes​(com.google.protobuf.ByteString value)

         Used for deleting a resource.

    `string delete = 5;`
    参数:
      `value` - The bytes for delete to set.
    返回:
      This builder for chaining.

  - ### hasPatch

    public boolean hasPatch()

         Used for updating a resource.

    `string patch = 6;`
    指定者:
      `hasPatch` 在接口中 `HttpRuleOrBuilder`
    返回:
      Whether the patch field is set.

  - ### getPatch

    public String getPatch()

         Used for updating a resource.

    `string patch = 6;`
    指定者:
      `getPatch` 在接口中 `HttpRuleOrBuilder`
    返回:
      The patch.

  - ### getPatchBytes

    public com.google.protobuf.ByteString getPatchBytes()

         Used for updating a resource.

    `string patch = 6;`
    指定者:
      `getPatchBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for patch.

  - ### setPatch

    public HttpRule.Builder setPatch​(String value)

         Used for updating a resource.

    `string patch = 6;`
    参数:
      `value` - The patch to set.
    返回:
      This builder for chaining.

  - ### clearPatch

    public HttpRule.Builder clearPatch()

         Used for updating a resource.

    `string patch = 6;`
    返回:
      This builder for chaining.

  - ### setPatchBytes

    public HttpRule.Builder setPatchBytes​(com.google.protobuf.ByteString value)

         Used for updating a resource.

    `string patch = 6;`
    参数:
      `value` - The bytes for patch to set.
    返回:
      This builder for chaining.

  - ### 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;`
    指定者:
      `hasCustom` 在接口中 `HttpRuleOrBuilder`
    返回:
      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;`
    指定者:
      `getCustom` 在接口中 `HttpRuleOrBuilder`
    返回:
      The custom.

  - ### 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;`
    指定者:
      `getCustomOrBuilder` 在接口中 `HttpRuleOrBuilder`

  - ### getBody

    public 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;`
    指定者:
      `getBody` 在接口中 `HttpRuleOrBuilder`
    返回:
      The body.

  - ### getBodyBytes

    public 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;`
    指定者:
      `getBodyBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for body.

  - ### setBody

    public HttpRule.Builder setBody​(String value)

         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;`
    参数:
      `value` - The body to set.
    返回:
      This builder for chaining.

  - ### clearBody

    public HttpRule.Builder clearBody()

         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;`
    返回:
      This builder for chaining.

  - ### setBodyBytes

    public HttpRule.Builder setBodyBytes​(com.google.protobuf.ByteString value)

         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;`
    参数:
      `value` - The bytes for body to set.
    返回:
      This builder for chaining.

  - ### getResponseBody

    public String getResponseBody()

         Optional. The name of the response field whose value is mapped to the HTTP
         body of response. Other response fields are ignored. When
         not set, the response message will be used as HTTP body of response.

    `string response_body = 12;`
    指定者:
      `getResponseBody` 在接口中 `HttpRuleOrBuilder`
    返回:
      The responseBody.

  - ### getResponseBodyBytes

    public com.google.protobuf.ByteString getResponseBodyBytes()

         Optional. The name of the response field whose value is mapped to the HTTP
         body of response. Other response fields are ignored. When
         not set, the response message will be used as HTTP body of response.

    `string response_body = 12;`
    指定者:
      `getResponseBodyBytes` 在接口中 `HttpRuleOrBuilder`
    返回:
      The bytes for responseBody.

  - ### setResponseBody

    public HttpRule.Builder setResponseBody​(String value)

         Optional. The name of the response field whose value is mapped to the HTTP
         body of response. Other response fields are ignored. When
         not set, the response message will be used as HTTP body of response.

    `string response_body = 12;`
    参数:
      `value` - The responseBody to set.
    返回:
      This builder for chaining.

  - ### clearResponseBody

    public HttpRule.Builder clearResponseBody()

         Optional. The name of the response field whose value is mapped to the HTTP
         body of response. Other response fields are ignored. When
         not set, the response message will be used as HTTP body of response.

    `string response_body = 12;`
    返回:
      This builder for chaining.

  - ### setResponseBodyBytes

    public HttpRule.Builder setResponseBodyBytes​(com.google.protobuf.ByteString value)

         Optional. The name of the response field whose value is mapped to the HTTP
         body of response. Other response fields are ignored. When
         not set, the response message will be used as HTTP body of response.

    `string response_body = 12;`
    参数:
      `value` - The bytes for responseBody to set.
    返回:
      This builder for chaining.

  - ### getAdditionalBindingsList

    public 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;`
    指定者:
      `getAdditionalBindingsList` 在接口中 `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;`
    指定者:
      `getAdditionalBindingsCount` 在接口中 `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;`
    指定者:
      `getAdditionalBindings` 在接口中 `HttpRuleOrBuilder`

  - ### setAdditionalBindings

    public HttpRule.Builder setAdditionalBindings​(int index, HttpRule value)

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

  - ### setAdditionalBindings

    public HttpRule.Builder setAdditionalBindings​(int index, HttpRule.Builder builderForValue)

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

  - ### addAdditionalBindings

    public HttpRule.Builder addAdditionalBindings​(HttpRule value)

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

  - ### addAdditionalBindings

    public HttpRule.Builder addAdditionalBindings​(int index, HttpRule value)

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

  - ### addAdditionalBindings

    public HttpRule.Builder addAdditionalBindings​(HttpRule.Builder builderForValue)

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

  - ### addAdditionalBindings

    public HttpRule.Builder addAdditionalBindings​(int index, HttpRule.Builder builderForValue)

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

  - ### addAllAdditionalBindings

    public HttpRule.Builder addAllAdditionalBindings​(Iterable<? extends HttpRule> values)

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

  - ### clearAdditionalBindings

    public HttpRule.Builder clearAdditionalBindings()

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

  - ### removeAdditionalBindings

    public HttpRule.Builder removeAdditionalBindings​(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;`

  - ### getAdditionalBindingsBuilder

    public HttpRule.Builder getAdditionalBindingsBuilder​(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;`

  - ### 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;`
    指定者:
      `getAdditionalBindingsOrBuilder` 在接口中 `HttpRuleOrBuilder`

  - ### getAdditionalBindingsOrBuilderList

    public 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;`
    指定者:
      `getAdditionalBindingsOrBuilderList` 在接口中 `HttpRuleOrBuilder`

  - ### addAdditionalBindingsBuilder

    public HttpRule.Builder addAdditionalBindingsBuilder()

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

  - ### addAdditionalBindingsBuilder

    public HttpRule.Builder addAdditionalBindingsBuilder​(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;`

  - ### getAdditionalBindingsBuilderList

    public List<HttpRule.Builder> getAdditionalBindingsBuilderList()

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

  - ### setUnknownFields

    public final HttpRule.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
    指定者:
      `setUnknownFields` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `setUnknownFields` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`

  - ### mergeUnknownFields

    public final HttpRule.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
    指定者:
      `mergeUnknownFields` 在接口中 `com.google.protobuf.Message.Builder`
    覆盖:
      `mergeUnknownFields` 在类中 `com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>`