java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.HttpRule

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

public final class HttpRule extends com.google.protobuf.GeneratedMessageV3 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

另请参阅:: 序列化表格

嵌套类概要

嵌套类

修饰符和类型

类

说明

static class

HttpRule.Builder

`HttpRule` defines the mapping of an RPC method to one or more HTTP REST API methods.

static class

HttpRule.PatternCase

从类继承的嵌套类/接口 com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

从类继承的嵌套类/接口 com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
字段概要

字段

修饰符和类型

字段

说明

static int

ADDITIONAL_BINDINGS_FIELD_NUMBER

static int

BODY_FIELD_NUMBER

static int

CUSTOM_FIELD_NUMBER

static int

DELETE_FIELD_NUMBER

static int

GET_FIELD_NUMBER

static int

PATCH_FIELD_NUMBER

static int

POST_FIELD_NUMBER

static int

PUT_FIELD_NUMBER

static int

RESPONSE_BODY_FIELD_NUMBER

static int

SELECTOR_FIELD_NUMBER

从类继承的字段 com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

从类继承的字段 com.google.protobuf.AbstractMessage
memoizedSize

从类继承的字段 com.google.protobuf.AbstractMessageLite
memoizedHashCode
方法概要

修饰符和类型

方法

说明

boolean

equals(Object obj)

HttpRule

getAdditionalBindings(int index)

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.

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()

String

getDelete()

Used for deleting a resource.

com.google.protobuf.ByteString

getDeleteBytes()

Used for deleting a resource.

static com.google.protobuf.Descriptors.Descriptor

getDescriptor()

String

getGet()

Used for listing and getting information about resources.

com.google.protobuf.ByteString

getGetBytes()

Used for listing and getting information about resources.

com.google.protobuf.Parser<HttpRule>

getParserForType()

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.

int

getSerializedSize()

com.google.protobuf.UnknownFieldSet

getUnknownFields()

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.

int

hashCode()

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()

static HttpRule.Builder

newBuilder()

static HttpRule.Builder

newBuilder(HttpRule prototype)

HttpRule.Builder

newBuilderForType()

protected HttpRule.Builder

newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

protected Object

newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

static HttpRule

parseDelimitedFrom(InputStream input)

static HttpRule

parseDelimitedFrom(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(InputStream input)

static HttpRule

parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static HttpRule

parseFrom(ByteBuffer data)

static HttpRule

parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)

static com.google.protobuf.Parser<HttpRule>

parser()

HttpRule.Builder

toBuilder()

void

writeTo(com.google.protobuf.CodedOutputStream output)

从类继承的方法 com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

从类继承的方法 com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

从类继承的方法 com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

从接口继承的方法 com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

从接口继承的方法 com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

字段详细资料
- SELECTOR_FIELD_NUMBER
  
  public static final int SELECTOR_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- GET_FIELD_NUMBER
  
  public static final int GET_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- PUT_FIELD_NUMBER
  
  public static final int PUT_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- POST_FIELD_NUMBER
  
  public static final int POST_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- DELETE_FIELD_NUMBER
  
  public static final int DELETE_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- PATCH_FIELD_NUMBER
  
  public static final int PATCH_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- CUSTOM_FIELD_NUMBER
  
  public static final int CUSTOM_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- BODY_FIELD_NUMBER
  
  public static final int BODY_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- RESPONSE_BODY_FIELD_NUMBER
  
  public static final int RESPONSE_BODY_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
- ADDITIONAL_BINDINGS_FIELD_NUMBER
  
  public static final int ADDITIONAL_BINDINGS_FIELD_NUMBER
  
  另请参阅:
  
  常量字段值
方法详细资料
- newInstance
  
  protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
  
  覆盖:
  
  newInstance 在类中 com.google.protobuf.GeneratedMessageV3
- getUnknownFields
  
  public final com.google.protobuf.UnknownFieldSet getUnknownFields()
  
  指定者:
  
  getUnknownFields 在接口中 com.google.protobuf.MessageOrBuilder
  
  覆盖:
  
  getUnknownFields 在类中 com.google.protobuf.GeneratedMessageV3
- getDescriptor
  
  public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
- internalGetFieldAccessorTable
  
  protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
  
  指定者:
  
  internalGetFieldAccessorTable 在类中 com.google.protobuf.GeneratedMessageV3
- getPatternCase
  
  public HttpRule.PatternCase getPatternCase()
  
  指定者:
  
  getPatternCase 在接口中 HttpRuleOrBuilder
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
- 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
- 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
- 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
- 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
- isInitialized
  
  public final boolean isInitialized()
  
  指定者:
  
  isInitialized 在接口中 com.google.protobuf.MessageLiteOrBuilder
  
  覆盖:
  
  isInitialized 在类中 com.google.protobuf.GeneratedMessageV3
- writeTo
  
  public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
  
  指定者:
  
  writeTo 在接口中 com.google.protobuf.MessageLite
  
  覆盖:
  
  writeTo 在类中 com.google.protobuf.GeneratedMessageV3
  
  抛出:
  
  IOException
- getSerializedSize
  
  public int getSerializedSize()
  
  指定者:
  
  getSerializedSize 在接口中 com.google.protobuf.MessageLite
  
  覆盖:
  
  getSerializedSize 在类中 com.google.protobuf.GeneratedMessageV3
- equals
  
  public boolean equals(Object obj)
  
  指定者:
  
  equals 在接口中 com.google.protobuf.Message
  
  覆盖:
  
  equals 在类中 com.google.protobuf.AbstractMessage
- hashCode
  
  public int hashCode()
  
  指定者:
  
  hashCode 在接口中 com.google.protobuf.Message
  
  覆盖:
  
  hashCode 在类中 com.google.protobuf.AbstractMessage
- parseFrom
  
  public static HttpRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
  
  抛出:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static HttpRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
  
  抛出:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static HttpRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
  
  抛出:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static HttpRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
  
  抛出:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static HttpRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
  
  抛出:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static HttpRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
  
  抛出:
  
  com.google.protobuf.InvalidProtocolBufferException
- parseFrom
  
  public static HttpRule parseFrom(InputStream input) throws IOException
  
  抛出:
  
  IOException
- parseFrom
  
  public static HttpRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
  
  抛出:
  
  IOException
- parseDelimitedFrom
  
  public static HttpRule parseDelimitedFrom(InputStream input) throws IOException
  
  抛出:
  
  IOException
- parseDelimitedFrom
  
  public static HttpRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
  
  抛出:
  
  IOException
- parseFrom
  
  public static HttpRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
  
  抛出:
  
  IOException
- parseFrom
  
  public static HttpRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
  
  抛出:
  
  IOException
- newBuilderForType
  
  public HttpRule.Builder newBuilderForType()
  
  指定者:
  
  newBuilderForType 在接口中 com.google.protobuf.Message
  
  指定者:
  
  newBuilderForType 在接口中 com.google.protobuf.MessageLite
- newBuilder
  
  public static HttpRule.Builder newBuilder()
- newBuilder
  
  public static HttpRule.Builder newBuilder(HttpRule prototype)
- toBuilder
  
  public HttpRule.Builder toBuilder()
  
  指定者:
  
  toBuilder 在接口中 com.google.protobuf.Message
  
  指定者:
  
  toBuilder 在接口中 com.google.protobuf.MessageLite
- newBuilderForType
  
  protected HttpRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
  
  指定者:
  
  newBuilderForType 在类中 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()
  
  指定者:
  
  getParserForType 在接口中 com.google.protobuf.Message
  
  指定者:
  
  getParserForType 在接口中 com.google.protobuf.MessageLite
  
  覆盖:
  
  getParserForType 在类中 com.google.protobuf.GeneratedMessageV3
- getDefaultInstanceForType
  
  public HttpRule getDefaultInstanceForType()
  
  指定者:
  
  getDefaultInstanceForType 在接口中 com.google.protobuf.MessageLiteOrBuilder
  
  指定者:
  
  getDefaultInstanceForType 在接口中 com.google.protobuf.MessageOrBuilder

类 HttpRule

嵌套类概要

从类继承的嵌套类/接口 com.google.protobuf.GeneratedMessageV3

从类继承的嵌套类/接口 com.google.protobuf.AbstractMessageLite

字段概要

从类继承的字段 com.google.protobuf.GeneratedMessageV3

从类继承的字段 com.google.protobuf.AbstractMessage

从类继承的字段 com.google.protobuf.AbstractMessageLite

方法概要

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

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

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

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

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

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

字段详细资料

SELECTOR_FIELD_NUMBER

GET_FIELD_NUMBER

PUT_FIELD_NUMBER

POST_FIELD_NUMBER

DELETE_FIELD_NUMBER

PATCH_FIELD_NUMBER

CUSTOM_FIELD_NUMBER

BODY_FIELD_NUMBER

RESPONSE_BODY_FIELD_NUMBER

ADDITIONAL_BINDINGS_FIELD_NUMBER

方法详细资料

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getPatternCase

getSelector

getSelectorBytes

hasGet

getGet

getGetBytes

hasPut

getPut

getPutBytes

hasPost

getPost

getPostBytes

hasDelete

getDelete

getDeleteBytes

hasPatch

getPatch

getPatchBytes

hasCustom

getCustom

getCustomOrBuilder

getBody

getBodyBytes

getResponseBody

getResponseBodyBytes

getAdditionalBindingsList

getAdditionalBindingsOrBuilderList

getAdditionalBindingsCount

getAdditionalBindings

getAdditionalBindingsOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder