程序包 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¶m=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-
方法概要
修饰符和类型方法说明addAdditionalBindings(int index, HttpRule value)Additional HTTP bindings for the selector.addAdditionalBindings(int index, HttpRule.Builder builderForValue)Additional HTTP bindings for the selector.addAdditionalBindings(HttpRule value)Additional HTTP bindings for the selector.addAdditionalBindings(HttpRule.Builder builderForValue)Additional HTTP bindings for the selector.Additional HTTP bindings for the selector.addAdditionalBindingsBuilder(int index)Additional HTTP bindings for the selector.addAllAdditionalBindings(Iterable<? extends HttpRule> values)Additional HTTP bindings for the selector.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)build()clear()Additional HTTP bindings for the selector.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.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.Used for deleting a resource.clearField(com.google.protobuf.Descriptors.FieldDescriptor field)clearGet()Used for listing and getting information about resources.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)Used for updating a resource.Used for creating a resource.clearPut()Used for updating a resource.Optional.Selects methods to which this rule applies.clone()getAdditionalBindings(int index)Additional HTTP bindings for the selector.getAdditionalBindingsBuilder(int index)Additional HTTP bindings for the selector.Additional HTTP bindings for the selector.intAdditional HTTP bindings for the selector.Additional HTTP bindings for the selector.getAdditionalBindingsOrBuilder(int index)Additional HTTP bindings for the selector.List<? extends HttpRuleOrBuilder>Additional HTTP bindings for the selector.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.ByteStringThe 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.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 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 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.Used for deleting a resource.com.google.protobuf.ByteStringUsed for deleting a resource.static com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorgetGet()Used for listing and getting information about resources.com.google.protobuf.ByteStringUsed for listing and getting information about resources.getPatch()Used for updating a resource.com.google.protobuf.ByteStringUsed for updating a resource.getPost()Used for creating a resource.com.google.protobuf.ByteStringUsed for creating a resource.getPut()Used for updating a resource.com.google.protobuf.ByteStringUsed for updating a resource.Optional.com.google.protobuf.ByteStringOptional.Selects methods to which this rule applies.com.google.protobuf.ByteStringSelects methods to which this rule applies.booleanThe 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.booleanUsed for deleting a resource.booleanhasGet()Used for listing and getting information about resources.booleanhasPatch()Used for updating a resource.booleanhasPost()Used for creating a resource.booleanhasPut()Used for updating a resource.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablebooleanmergeCustom(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.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)mergeFrom(com.google.protobuf.Message other)mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)removeAdditionalBindings(int index)Additional HTTP bindings for the selector.setAdditionalBindings(int index, HttpRule value)Additional HTTP bindings for the selector.setAdditionalBindings(int index, HttpRule.Builder builderForValue)Additional HTTP bindings for the selector.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.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.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.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.Used for deleting a resource.setDeleteBytes(com.google.protobuf.ByteString value)Used for deleting a resource.Used for listing and getting information about resources.setGetBytes(com.google.protobuf.ByteString value)Used for listing and getting information about resources.Used for updating a resource.setPatchBytes(com.google.protobuf.ByteString value)Used for updating a resource.Used for creating a resource.setPostBytes(com.google.protobuf.ByteString value)Used for creating a resource.Used for updating a resource.setPutBytes(com.google.protobuf.ByteString value)Used for updating a resource.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)setResponseBody(String value)Optional.setResponseBodyBytes(com.google.protobuf.ByteString value)Optional.setSelector(String value)Selects methods to which this rule applies.setSelectorBytes(com.google.protobuf.ByteString value)Selects methods to which this rule applies.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从接口继承的方法 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
- 指定者:
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
- 指定者:
getDefaultInstanceForType在接口中com.google.protobuf.MessageLiteOrBuilder- 指定者:
getDefaultInstanceForType在接口中com.google.protobuf.MessageOrBuilder
-
build
- 指定者:
build在接口中com.google.protobuf.Message.Builder- 指定者:
build在接口中com.google.protobuf.MessageLite.Builder
-
buildPartial
- 指定者:
buildPartial在接口中com.google.protobuf.Message.Builder- 指定者:
buildPartial在接口中com.google.protobuf.MessageLite.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
- 指定者:
clearField在接口中com.google.protobuf.Message.Builder- 覆盖:
clearField在类中com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
clearOneof
- 指定者:
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
- 指定者:
mergeFrom在接口中com.google.protobuf.Message.Builder- 覆盖:
mergeFrom在类中com.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>
-
mergeFrom
-
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
- 指定者:
getPatternCase在接口中HttpRuleOrBuilder
-
clearPattern
-
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
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
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
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
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
Used for listing and getting information about resources.
string get = 2;- 参数:
value- The get to set.- 返回:
- This builder for chaining.
-
clearGet
Used for listing and getting information about resources.
string get = 2;- 返回:
- This builder for chaining.
-
setGetBytes
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
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
Used for updating a resource.
string put = 3;- 参数:
value- The put to set.- 返回:
- This builder for chaining.
-
clearPut
Used for updating a resource.
string put = 3;- 返回:
- This builder for chaining.
-
setPutBytes
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
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
Used for creating a resource.
string post = 4;- 参数:
value- The post to set.- 返回:
- This builder for chaining.
-
clearPost
Used for creating a resource.
string post = 4;- 返回:
- This builder for chaining.
-
setPostBytes
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
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
Used for deleting a resource.
string delete = 5;- 参数:
value- The delete to set.- 返回:
- This builder for chaining.
-
clearDelete
Used for deleting a resource.
string delete = 5;- 返回:
- This builder for chaining.
-
setDeleteBytes
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
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
Used for updating a resource.
string patch = 6;- 参数:
value- The patch to set.- 返回:
- This builder for chaining.
-
clearPatch
Used for updating a resource.
string patch = 6;- 返回:
- This builder for chaining.
-
setPatchBytes
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
- 指定者:
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>
-