Package com.google.api
Class HttpRule.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
- com.google.api.HttpRule.Builder
-
- All Implemented Interfaces:
HttpRuleOrBuilder
,com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.lang.Cloneable
- Enclosing class:
- HttpRule
public static final class HttpRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder> implements HttpRuleOrBuilder
gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.
Protobuf typegoogle.api.HttpRule
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description 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(java.lang.Iterable<? extends HttpRule> values)
Additional HTTP bindings for the selector.HttpRule.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
HttpRule
build()
HttpRule
buildPartial()
HttpRule.Builder
clear()
HttpRule.Builder
clearAdditionalBindings()
Additional HTTP bindings for the selector.HttpRule.Builder
clearBody()
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.HttpRule.Builder
clearCustom()
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.HttpRule.Builder
clearDelete()
Maps to HTTP DELETE.HttpRule.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
HttpRule.Builder
clearGet()
Maps to HTTP GET.HttpRule.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
HttpRule.Builder
clearPatch()
Maps to HTTP PATCH.HttpRule.Builder
clearPattern()
HttpRule.Builder
clearPost()
Maps to HTTP POST.HttpRule.Builder
clearPut()
Maps to HTTP PUT.HttpRule.Builder
clearResponseBody()
Optional.HttpRule.Builder
clearSelector()
Selects a method to which this rule applies.HttpRule.Builder
clone()
HttpRule
getAdditionalBindings(int index)
Additional HTTP bindings for the selector.HttpRule.Builder
getAdditionalBindingsBuilder(int index)
Additional HTTP bindings for the selector.java.util.List<HttpRule.Builder>
getAdditionalBindingsBuilderList()
Additional HTTP bindings for the selector.int
getAdditionalBindingsCount()
Additional HTTP bindings for the selector.java.util.List<HttpRule>
getAdditionalBindingsList()
Additional HTTP bindings for the selector.HttpRuleOrBuilder
getAdditionalBindingsOrBuilder(int index)
Additional HTTP bindings for the selector.java.util.List<? extends HttpRuleOrBuilder>
getAdditionalBindingsOrBuilderList()
Additional HTTP bindings for the selector.java.lang.String
getBody()
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.com.google.protobuf.ByteString
getBodyBytes()
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.CustomHttpPattern
getCustom()
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.CustomHttpPattern.Builder
getCustomBuilder()
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.CustomHttpPatternOrBuilder
getCustomOrBuilder()
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.HttpRule
getDefaultInstanceForType()
java.lang.String
getDelete()
Maps to HTTP DELETE.com.google.protobuf.ByteString
getDeleteBytes()
Maps to HTTP DELETE.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.String
getGet()
Maps to HTTP GET.com.google.protobuf.ByteString
getGetBytes()
Maps to HTTP GET.java.lang.String
getPatch()
Maps to HTTP PATCH.com.google.protobuf.ByteString
getPatchBytes()
Maps to HTTP PATCH.HttpRule.PatternCase
getPatternCase()
java.lang.String
getPost()
Maps to HTTP POST.com.google.protobuf.ByteString
getPostBytes()
Maps to HTTP POST.java.lang.String
getPut()
Maps to HTTP PUT.com.google.protobuf.ByteString
getPutBytes()
Maps to HTTP PUT.java.lang.String
getResponseBody()
Optional.com.google.protobuf.ByteString
getResponseBodyBytes()
Optional.java.lang.String
getSelector()
Selects a method to which this rule applies.com.google.protobuf.ByteString
getSelectorBytes()
Selects a method to which this rule applies.boolean
hasCustom()
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule.boolean
hasDelete()
Maps to HTTP DELETE.boolean
hasGet()
Maps to HTTP GET.boolean
hasPatch()
Maps to HTTP PATCH.boolean
hasPost()
Maps to HTTP POST.boolean
hasPut()
Maps to HTTP PUT.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
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(java.lang.String value)
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.HttpRule.Builder
setBodyBytes(com.google.protobuf.ByteString value)
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.HttpRule.Builder
setCustom(CustomHttpPattern 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(java.lang.String value)
Maps to HTTP DELETE.HttpRule.Builder
setDeleteBytes(com.google.protobuf.ByteString value)
Maps to HTTP DELETE.HttpRule.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
HttpRule.Builder
setGet(java.lang.String value)
Maps to HTTP GET.HttpRule.Builder
setGetBytes(com.google.protobuf.ByteString value)
Maps to HTTP GET.HttpRule.Builder
setPatch(java.lang.String value)
Maps to HTTP PATCH.HttpRule.Builder
setPatchBytes(com.google.protobuf.ByteString value)
Maps to HTTP PATCH.HttpRule.Builder
setPost(java.lang.String value)
Maps to HTTP POST.HttpRule.Builder
setPostBytes(com.google.protobuf.ByteString value)
Maps to HTTP POST.HttpRule.Builder
setPut(java.lang.String value)
Maps to HTTP PUT.HttpRule.Builder
setPutBytes(com.google.protobuf.ByteString value)
Maps to HTTP PUT.HttpRule.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
HttpRule.Builder
setResponseBody(java.lang.String value)
Optional.HttpRule.Builder
setResponseBodyBytes(com.google.protobuf.ByteString value)
Optional.HttpRule.Builder
setSelector(java.lang.String value)
Selects a method to which this rule applies.HttpRule.Builder
setSelectorBytes(com.google.protobuf.ByteString value)
Selects a method to which this rule applies.HttpRule.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableBuilder
addExtension, clearExtension, extensionsAreInitialized, getAllFields, getExtension, getExtension, getExtensionCount, getField, getFieldBuilder, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, hasExtension, hasField, mergeExtensionFields, newBuilderForField, parseUnknownField, setExtension, setExtension
-
Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
getOneofFieldDescriptor, getUnknownFields, getUnknownFieldSetBuilder, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, onBuilt, onChanged, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Overrides:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
clear
public HttpRule.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<HttpRule.Builder>
-
getDefaultInstanceForType
public HttpRule getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public HttpRule build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public HttpRule buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public HttpRule.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
setField
public HttpRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
clearField
public HttpRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
clearOneof
public HttpRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
setRepeatedField
public HttpRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
addRepeatedField
public HttpRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
mergeFrom
public HttpRule.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>
-
mergeFrom
public HttpRule.Builder mergeFrom(HttpRule other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.ExtendableBuilder<com.google.protobuf.GeneratedMessageV3,HttpRule.Builder>
-
mergeFrom
public HttpRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>
- Throws:
java.io.IOException
-
getPatternCase
public HttpRule.PatternCase getPatternCase()
- Specified by:
getPatternCase
in interfaceHttpRuleOrBuilder
-
clearPattern
public HttpRule.Builder clearPattern()
-
getSelector
public java.lang.String getSelector()
Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
- Specified by:
getSelector
in interfaceHttpRuleOrBuilder
- Returns:
- The selector.
-
getSelectorBytes
public com.google.protobuf.ByteString getSelectorBytes()
Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
- Specified by:
getSelectorBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for selector.
-
setSelector
public HttpRule.Builder setSelector(java.lang.String value)
Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
- Parameters:
value
- The selector to set.- Returns:
- This builder for chaining.
-
clearSelector
public HttpRule.Builder clearSelector()
Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
- Returns:
- This builder for chaining.
-
setSelectorBytes
public HttpRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
Selects a method to which this rule applies. Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
string selector = 1;
- Parameters:
value
- The bytes for selector to set.- Returns:
- This builder for chaining.
-
hasGet
public boolean hasGet()
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 2;
- Specified by:
hasGet
in interfaceHttpRuleOrBuilder
- Returns:
- Whether the get field is set.
-
getGet
public java.lang.String getGet()
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 2;
- Specified by:
getGet
in interfaceHttpRuleOrBuilder
- Returns:
- The get.
-
getGetBytes
public com.google.protobuf.ByteString getGetBytes()
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 2;
- Specified by:
getGetBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for get.
-
setGet
public HttpRule.Builder setGet(java.lang.String value)
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 2;
- Parameters:
value
- The get to set.- Returns:
- This builder for chaining.
-
clearGet
public HttpRule.Builder clearGet()
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 2;
- Returns:
- This builder for chaining.
-
setGetBytes
public HttpRule.Builder setGetBytes(com.google.protobuf.ByteString value)
Maps to HTTP GET. Used for listing and getting information about resources.
string get = 2;
- Parameters:
value
- The bytes for get to set.- Returns:
- This builder for chaining.
-
hasPut
public boolean hasPut()
Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
- Specified by:
hasPut
in interfaceHttpRuleOrBuilder
- Returns:
- Whether the put field is set.
-
getPut
public java.lang.String getPut()
Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
- Specified by:
getPut
in interfaceHttpRuleOrBuilder
- Returns:
- The put.
-
getPutBytes
public com.google.protobuf.ByteString getPutBytes()
Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
- Specified by:
getPutBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for put.
-
setPut
public HttpRule.Builder setPut(java.lang.String value)
Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
- Parameters:
value
- The put to set.- Returns:
- This builder for chaining.
-
clearPut
public HttpRule.Builder clearPut()
Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
- Returns:
- This builder for chaining.
-
setPutBytes
public HttpRule.Builder setPutBytes(com.google.protobuf.ByteString value)
Maps to HTTP PUT. Used for replacing a resource.
string put = 3;
- Parameters:
value
- The bytes for put to set.- Returns:
- This builder for chaining.
-
hasPost
public boolean hasPost()
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
- Specified by:
hasPost
in interfaceHttpRuleOrBuilder
- Returns:
- Whether the post field is set.
-
getPost
public java.lang.String getPost()
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
- Specified by:
getPost
in interfaceHttpRuleOrBuilder
- Returns:
- The post.
-
getPostBytes
public com.google.protobuf.ByteString getPostBytes()
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
- Specified by:
getPostBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for post.
-
setPost
public HttpRule.Builder setPost(java.lang.String value)
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
- Parameters:
value
- The post to set.- Returns:
- This builder for chaining.
-
clearPost
public HttpRule.Builder clearPost()
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
- Returns:
- This builder for chaining.
-
setPostBytes
public HttpRule.Builder setPostBytes(com.google.protobuf.ByteString value)
Maps to HTTP POST. Used for creating a resource or performing an action.
string post = 4;
- Parameters:
value
- The bytes for post to set.- Returns:
- This builder for chaining.
-
hasDelete
public boolean hasDelete()
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
- Specified by:
hasDelete
in interfaceHttpRuleOrBuilder
- Returns:
- Whether the delete field is set.
-
getDelete
public java.lang.String getDelete()
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
- Specified by:
getDelete
in interfaceHttpRuleOrBuilder
- Returns:
- The delete.
-
getDeleteBytes
public com.google.protobuf.ByteString getDeleteBytes()
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
- Specified by:
getDeleteBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for delete.
-
setDelete
public HttpRule.Builder setDelete(java.lang.String value)
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
- Parameters:
value
- The delete to set.- Returns:
- This builder for chaining.
-
clearDelete
public HttpRule.Builder clearDelete()
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
- Returns:
- This builder for chaining.
-
setDeleteBytes
public HttpRule.Builder setDeleteBytes(com.google.protobuf.ByteString value)
Maps to HTTP DELETE. Used for deleting a resource.
string delete = 5;
- Parameters:
value
- The bytes for delete to set.- Returns:
- This builder for chaining.
-
hasPatch
public boolean hasPatch()
Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
- Specified by:
hasPatch
in interfaceHttpRuleOrBuilder
- Returns:
- Whether the patch field is set.
-
getPatch
public java.lang.String getPatch()
Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
- Specified by:
getPatch
in interfaceHttpRuleOrBuilder
- Returns:
- The patch.
-
getPatchBytes
public com.google.protobuf.ByteString getPatchBytes()
Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
- Specified by:
getPatchBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for patch.
-
setPatch
public HttpRule.Builder setPatch(java.lang.String value)
Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
- Parameters:
value
- The patch to set.- Returns:
- This builder for chaining.
-
clearPatch
public HttpRule.Builder clearPatch()
Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
- Returns:
- This builder for chaining.
-
setPatchBytes
public HttpRule.Builder setPatchBytes(com.google.protobuf.ByteString value)
Maps to HTTP PATCH. Used for updating a resource.
string patch = 6;
- Parameters:
value
- The bytes for patch to set.- Returns:
- 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;
- Specified by:
hasCustom
in interfaceHttpRuleOrBuilder
- Returns:
- Whether the custom field is set.
-
getCustom
public CustomHttpPattern getCustom()
The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.
.google.api.CustomHttpPattern custom = 8;
- Specified by:
getCustom
in interfaceHttpRuleOrBuilder
- Returns:
- 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;
- Specified by:
getCustomOrBuilder
in interfaceHttpRuleOrBuilder
-
getBody
public java.lang.String getBody()
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
string body = 7;
- Specified by:
getBody
in interfaceHttpRuleOrBuilder
- Returns:
- The body.
-
getBodyBytes
public com.google.protobuf.ByteString getBodyBytes()
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
string body = 7;
- Specified by:
getBodyBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for body.
-
setBody
public HttpRule.Builder setBody(java.lang.String value)
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
string body = 7;
- Parameters:
value
- The body to set.- Returns:
- This builder for chaining.
-
clearBody
public HttpRule.Builder clearBody()
The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
string body = 7;
- Returns:
- 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 request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
string body = 7;
- Parameters:
value
- The bytes for body to set.- Returns:
- This builder for chaining.
-
getResponseBody
public java.lang.String getResponseBody()
Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
string response_body = 12;
- Specified by:
getResponseBody
in interfaceHttpRuleOrBuilder
- Returns:
- The responseBody.
-
getResponseBodyBytes
public com.google.protobuf.ByteString getResponseBodyBytes()
Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
string response_body = 12;
- Specified by:
getResponseBodyBytes
in interfaceHttpRuleOrBuilder
- Returns:
- The bytes for responseBody.
-
setResponseBody
public HttpRule.Builder setResponseBody(java.lang.String value)
Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
string response_body = 12;
- Parameters:
value
- The responseBody to set.- Returns:
- This builder for chaining.
-
clearResponseBody
public HttpRule.Builder clearResponseBody()
Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
string response_body = 12;
- Returns:
- 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 response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The referred field must be present at the top-level of the response message type.
string response_body = 12;
- Parameters:
value
- The bytes for responseBody to set.- Returns:
- This builder for chaining.
-
getAdditionalBindingsList
public java.util.List<HttpRule> getAdditionalBindingsList()
Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
repeated .google.api.HttpRule additional_bindings = 11;
- Specified by:
getAdditionalBindingsList
in interfaceHttpRuleOrBuilder
-
getAdditionalBindingsCount
public int getAdditionalBindingsCount()
Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
repeated .google.api.HttpRule additional_bindings = 11;
- Specified by:
getAdditionalBindingsCount
in interfaceHttpRuleOrBuilder
-
getAdditionalBindings
public HttpRule getAdditionalBindings(int index)
Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
repeated .google.api.HttpRule additional_bindings = 11;
- Specified by:
getAdditionalBindings
in interfaceHttpRuleOrBuilder
-
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(java.lang.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;
- Specified by:
getAdditionalBindingsOrBuilder
in interfaceHttpRuleOrBuilder
-
getAdditionalBindingsOrBuilderList
public java.util.List<? extends HttpRuleOrBuilder> getAdditionalBindingsOrBuilderList()
Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep).
repeated .google.api.HttpRule additional_bindings = 11;
- Specified by:
getAdditionalBindingsOrBuilderList
in interfaceHttpRuleOrBuilder
-
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 java.util.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)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
mergeUnknownFields
public final HttpRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
-
-