com.google.api.HttpRule Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ydb-sdk-jdbc-uberjar Show documentation
Show all versions of ydb-sdk-jdbc-uberjar Show documentation
JDBC client implementation over Table client, single jar
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/http.proto
package com.google.api;
/**
*
*
*
* # gRPC Transcoding
* gRPC Transcoding is a feature for mapping between a gRPC method and one or
* more HTTP REST endpoints. It allows developers to build a single API service
* that supports both gRPC APIs and REST APIs. Many systems, including [Google
* APIs](https://github.com/googleapis/googleapis),
* [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
* Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
* and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
* and use it for large scale production services.
* `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
* how different portions of the gRPC request message are mapped to the URL
* path, URL query parameters, and HTTP request body. It also controls how the
* gRPC response message is mapped to the HTTP response body. `HttpRule` is
* typically specified as an `google.api.http` annotation on the gRPC method.
* Each mapping specifies a URL path template and an HTTP method. The path
* template may refer to one or more fields in the gRPC request message, as long
* as each field is a non-repeated field with a primitive (non-message) type.
* The path template controls how fields of the request message are mapped to
* the URL path.
* Example:
* service Messaging {
* rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = {
* get: "/v1/{name=messages/*}"
* };
* }
* }
* message GetMessageRequest {
* string name = 1; // Mapped to URL path.
* }
* message Message {
* string text = 1; // The resource content.
* }
* This enables an HTTP REST to gRPC mapping as below:
* HTTP | gRPC
* -----|-----
* `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
* Any fields in the request message which are not bound by the path template
* automatically become HTTP query parameters if there is no HTTP request body.
* For example:
* service Messaging {
* rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = {
* get:"/v1/messages/{message_id}"
* };
* }
* }
* message GetMessageRequest {
* message SubMessage {
* string subfield = 1;
* }
* string message_id = 1; // Mapped to URL path.
* int64 revision = 2; // Mapped to URL query parameter `revision`.
* SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
* }
* This enables a HTTP JSON to RPC mapping as below:
* HTTP | gRPC
* -----|-----
* `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
* `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
* "foo"))`
* Note that fields which are mapped to URL query parameters must have a
* primitive type or a repeated primitive type or a non-repeated message type.
* In the case of a repeated type, the parameter can be repeated in the URL
* as `...?param=A¶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 | gRPC
* -----|-----
* `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
* "123456" message { text: "Hi!" })`
* The special name `*` can be used in the body mapping to define that
* every field not bound by the path template should be mapped to the
* request body. This enables the following alternative definition of
* the update method:
* service Messaging {
* rpc UpdateMessage(Message) returns (Message) {
* option (google.api.http) = {
* patch: "/v1/messages/{message_id}"
* body: "*"
* };
* }
* }
* message Message {
* string message_id = 1;
* string text = 2;
* }
* The following HTTP JSON to RPC mapping is enabled:
* HTTP | gRPC
* -----|-----
* `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
* "123456" text: "Hi!")`
* Note that when using `*` in the body mapping, it is not possible to
* have HTTP parameters, as all fields not bound by the path end in
* the body. This makes this option more rarely used in practice when
* defining REST APIs. The common usage of `*` is in custom methods
* which don't use the URL at all for transferring data.
* It is possible to define multiple HTTP methods for one RPC by using
* the `additional_bindings` option. Example:
* service Messaging {
* rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = {
* get: "/v1/messages/{message_id}"
* additional_bindings {
* get: "/v1/users/{user_id}/messages/{message_id}"
* }
* };
* }
* }
* message GetMessageRequest {
* string message_id = 1;
* string user_id = 2;
* }
* This enables the following two alternative HTTP JSON to RPC mappings:
* HTTP | gRPC
* -----|-----
* `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
* `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
* "123456")`
* ## Rules for HTTP mapping
* 1. Leaf request fields (recursive expansion nested messages in the request
* message) are classified into three categories:
* - Fields referred by the path template. They are passed via the URL path.
* - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
* request body.
* - All other fields are passed via the URL query parameters, and the
* parameter name is the field path in the request message. A repeated
* field can be represented as multiple query parameters under the same
* name.
* 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
* are passed via URL path and HTTP request body.
* 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
* fields are passed via URL path and URL query parameters.
* ### Path template syntax
* Template = "/" Segments [ Verb ] ;
* Segments = Segment { "/" Segment } ;
* Segment = "*" | "**" | LITERAL | Variable ;
* Variable = "{" FieldPath [ "=" Segments ] "}" ;
* FieldPath = IDENT { "." IDENT } ;
* Verb = ":" LITERAL ;
* The syntax `*` matches a single URL path segment. The syntax `**` matches
* zero or more URL path segments, which must be the last part of the URL path
* except the `Verb`.
* The syntax `Variable` matches part of the URL path as specified by its
* template. A variable template must not contain other variables. If a variable
* matches a single path segment, its template may be omitted, e.g. `{var}`
* is equivalent to `{var=*}`.
* The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
* contains any reserved character, such characters should be percent-encoded
* before the matching.
* If a variable contains exactly one path segment, such as `"{var}"` or
* `"{var=*}"`, when such a variable is expanded into a URL path on the client
* side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
* server side does the reverse decoding. Such variables show up in the
* [Discovery
* Document](https://developers.google.com/discovery/v1/reference/apis) as
* `{var}`.
* If a variable contains multiple path segments, such as `"{var=foo/*}"`
* or `"{var=**}"`, when such a variable is expanded into a URL path on the
* client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
* The server side does the reverse decoding, except "%2F" and "%2f" are left
* unchanged. Such variables show up in the
* [Discovery
* Document](https://developers.google.com/discovery/v1/reference/apis) as
* `{+var}`.
* ## Using gRPC API Service Configuration
* gRPC API Service Configuration (service config) is a configuration language
* for configuring a gRPC service to become a user-facing product. The
* service config is simply the YAML representation of the `google.api.Service`
* proto message.
* As an alternative to annotating your proto file, you can configure gRPC
* transcoding in your service config YAML files. You do this by specifying a
* `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
* effect as the proto annotation. This can be particularly useful if you
* have a proto that is reused in multiple services. Note that any transcoding
* specified in the service config will override any matching transcoding
* configuration in the proto.
* Example:
* http:
* rules:
* # Selects a gRPC method and applies HttpRule to it.
* - selector: example.v1.Messaging.GetMessage
* get: /v1/messages/{message_id}/{sub.subfield}
* ## Special notes
* When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
* proto to JSON conversion must follow the [proto3
* specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
* While the single segment variable follows the semantics of
* [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
* Expansion, the multi segment variable **does not** follow RFC 6570 Section
* 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
* does not expand special characters like `?` and `#`, which would lead
* to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
* for multi segment variables.
* The path variables **must not** refer to any repeated or mapped field,
* because client libraries are not capable of handling such variable expansion.
* The path variables **must not** capture the leading "/" character. The reason
* is that the most common use case "{var}" does not capture the leading "/"
* character. For consistency, all path variables must share the same behavior.
* Repeated message fields must not be mapped to URL query parameters, because
* no client library can support such complicated mapping.
* If an API needs to use a JSON array for request or response body, it can map
* the request or response body to a repeated field. However, some gRPC
* Transcoding implementations may not support this feature.
*
*
* Protobuf type {@code google.api.HttpRule}
*/
public final class HttpRule extends com.google.protobuf.GeneratedMessageV3
implements
// @@protoc_insertion_point(message_implements:google.api.HttpRule)
HttpRuleOrBuilder {
private static final long serialVersionUID = 0L;
// Use HttpRule.newBuilder() to construct.
private HttpRule(com.google.protobuf.GeneratedMessageV3.Builder builder) {
super(builder);
}
private HttpRule() {
selector_ = "";
body_ = "";
responseBody_ = "";
additionalBindings_ = java.util.Collections.emptyList();
}
@java.lang.Override
@SuppressWarnings({"unused"})
protected java.lang.Object newInstance(UnusedPrivateParameter unused) {
return new HttpRule();
}
@java.lang.Override
public final com.google.protobuf.UnknownFieldSet getUnknownFields() {
return this.unknownFields;
}
private HttpRule(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
this();
if (extensionRegistry == null) {
throw new java.lang.NullPointerException();
}
int mutable_bitField0_ = 0;
com.google.protobuf.UnknownFieldSet.Builder unknownFields =
com.google.protobuf.UnknownFieldSet.newBuilder();
try {
boolean done = false;
while (!done) {
int tag = input.readTag();
switch (tag) {
case 0:
done = true;
break;
case 10:
{
java.lang.String s = input.readStringRequireUtf8();
selector_ = s;
break;
}
case 18:
{
java.lang.String s = input.readStringRequireUtf8();
patternCase_ = 2;
pattern_ = s;
break;
}
case 26:
{
java.lang.String s = input.readStringRequireUtf8();
patternCase_ = 3;
pattern_ = s;
break;
}
case 34:
{
java.lang.String s = input.readStringRequireUtf8();
patternCase_ = 4;
pattern_ = s;
break;
}
case 42:
{
java.lang.String s = input.readStringRequireUtf8();
patternCase_ = 5;
pattern_ = s;
break;
}
case 50:
{
java.lang.String s = input.readStringRequireUtf8();
patternCase_ = 6;
pattern_ = s;
break;
}
case 58:
{
java.lang.String s = input.readStringRequireUtf8();
body_ = s;
break;
}
case 66:
{
com.google.api.CustomHttpPattern.Builder subBuilder = null;
if (patternCase_ == 8) {
subBuilder = ((com.google.api.CustomHttpPattern) pattern_).toBuilder();
}
pattern_ =
input.readMessage(com.google.api.CustomHttpPattern.parser(), extensionRegistry);
if (subBuilder != null) {
subBuilder.mergeFrom((com.google.api.CustomHttpPattern) pattern_);
pattern_ = subBuilder.buildPartial();
}
patternCase_ = 8;
break;
}
case 90:
{
if (!((mutable_bitField0_ & 0x00000001) != 0)) {
additionalBindings_ = new java.util.ArrayList();
mutable_bitField0_ |= 0x00000001;
}
additionalBindings_.add(
input.readMessage(com.google.api.HttpRule.parser(), extensionRegistry));
break;
}
case 98:
{
java.lang.String s = input.readStringRequireUtf8();
responseBody_ = s;
break;
}
default:
{
if (!parseUnknownField(input, unknownFields, extensionRegistry, tag)) {
done = true;
}
break;
}
}
}
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(this);
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e).setUnfinishedMessage(this);
} finally {
if (((mutable_bitField0_ & 0x00000001) != 0)) {
additionalBindings_ = java.util.Collections.unmodifiableList(additionalBindings_);
}
this.unknownFields = unknownFields.build();
makeExtensionsImmutable();
}
}
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.api.HttpProto.internal_static_google_api_HttpRule_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.api.HttpProto.internal_static_google_api_HttpRule_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.api.HttpRule.class, com.google.api.HttpRule.Builder.class);
}
private int patternCase_ = 0;
private java.lang.Object pattern_;
public enum PatternCase
implements
com.google.protobuf.Internal.EnumLite,
com.google.protobuf.AbstractMessage.InternalOneOfEnum {
GET(2),
PUT(3),
POST(4),
DELETE(5),
PATCH(6),
CUSTOM(8),
PATTERN_NOT_SET(0);
private final int value;
private PatternCase(int value) {
this.value = value;
}
/**
* @param value The number of the enum to look for.
* @return The enum associated with the given number.
* @deprecated Use {@link #forNumber(int)} instead.
*/
@java.lang.Deprecated
public static PatternCase valueOf(int value) {
return forNumber(value);
}
public static PatternCase forNumber(int value) {
switch (value) {
case 2:
return GET;
case 3:
return PUT;
case 4:
return POST;
case 5:
return DELETE;
case 6:
return PATCH;
case 8:
return CUSTOM;
case 0:
return PATTERN_NOT_SET;
default:
return null;
}
}
public int getNumber() {
return this.value;
}
};
public PatternCase getPatternCase() {
return PatternCase.forNumber(patternCase_);
}
public static final int SELECTOR_FIELD_NUMBER = 1;
private volatile java.lang.Object selector_;
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @return The selector.
*/
@java.lang.Override
public java.lang.String getSelector() {
java.lang.Object ref = selector_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
selector_ = s;
return s;
}
}
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @return The bytes for selector.
*/
@java.lang.Override
public com.google.protobuf.ByteString getSelectorBytes() {
java.lang.Object ref = selector_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
selector_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int GET_FIELD_NUMBER = 2;
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @return The get.
*/
public java.lang.String getGet() {
java.lang.Object ref = "";
if (patternCase_ == 2) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 2) {
pattern_ = s;
}
return s;
}
}
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @return The bytes for get.
*/
public com.google.protobuf.ByteString getGetBytes() {
java.lang.Object ref = "";
if (patternCase_ == 2) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 2) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int PUT_FIELD_NUMBER = 3;
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @return The put.
*/
public java.lang.String getPut() {
java.lang.Object ref = "";
if (patternCase_ == 3) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 3) {
pattern_ = s;
}
return s;
}
}
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @return The bytes for put.
*/
public com.google.protobuf.ByteString getPutBytes() {
java.lang.Object ref = "";
if (patternCase_ == 3) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 3) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int POST_FIELD_NUMBER = 4;
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @return The post.
*/
public java.lang.String getPost() {
java.lang.Object ref = "";
if (patternCase_ == 4) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 4) {
pattern_ = s;
}
return s;
}
}
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @return The bytes for post.
*/
public com.google.protobuf.ByteString getPostBytes() {
java.lang.Object ref = "";
if (patternCase_ == 4) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 4) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int DELETE_FIELD_NUMBER = 5;
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @return The delete.
*/
public java.lang.String getDelete() {
java.lang.Object ref = "";
if (patternCase_ == 5) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 5) {
pattern_ = s;
}
return s;
}
}
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @return The bytes for delete.
*/
public com.google.protobuf.ByteString getDeleteBytes() {
java.lang.Object ref = "";
if (patternCase_ == 5) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 5) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int PATCH_FIELD_NUMBER = 6;
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @return The patch.
*/
public java.lang.String getPatch() {
java.lang.Object ref = "";
if (patternCase_ == 6) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 6) {
pattern_ = s;
}
return s;
}
}
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @return The bytes for patch.
*/
public com.google.protobuf.ByteString getPatchBytes() {
java.lang.Object ref = "";
if (patternCase_ == 6) {
ref = pattern_;
}
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 6) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int CUSTOM_FIELD_NUMBER = 8;
/**
*
*
*
* 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;
*
* @return Whether the custom field is set.
*/
@java.lang.Override
public boolean hasCustom() {
return patternCase_ == 8;
}
/**
*
*
*
* 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;
*
* @return The custom.
*/
@java.lang.Override
public com.google.api.CustomHttpPattern getCustom() {
if (patternCase_ == 8) {
return (com.google.api.CustomHttpPattern) pattern_;
}
return com.google.api.CustomHttpPattern.getDefaultInstance();
}
/**
*
*
*
* 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;
*/
@java.lang.Override
public com.google.api.CustomHttpPatternOrBuilder getCustomOrBuilder() {
if (patternCase_ == 8) {
return (com.google.api.CustomHttpPattern) pattern_;
}
return com.google.api.CustomHttpPattern.getDefaultInstance();
}
public static final int BODY_FIELD_NUMBER = 7;
private volatile java.lang.Object body_;
/**
*
*
*
* 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;
*
* @return The body.
*/
@java.lang.Override
public java.lang.String getBody() {
java.lang.Object ref = body_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
body_ = s;
return s;
}
}
/**
*
*
*
* 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;
*
* @return The bytes for body.
*/
@java.lang.Override
public com.google.protobuf.ByteString getBodyBytes() {
java.lang.Object ref = body_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
body_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int RESPONSE_BODY_FIELD_NUMBER = 12;
private volatile java.lang.Object responseBody_;
/**
*
*
*
* 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;
*
* @return The responseBody.
*/
@java.lang.Override
public java.lang.String getResponseBody() {
java.lang.Object ref = responseBody_;
if (ref instanceof java.lang.String) {
return (java.lang.String) ref;
} else {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
responseBody_ = s;
return s;
}
}
/**
*
*
*
* 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;
*
* @return The bytes for responseBody.
*/
@java.lang.Override
public com.google.protobuf.ByteString getResponseBodyBytes() {
java.lang.Object ref = responseBody_;
if (ref instanceof java.lang.String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
responseBody_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
public static final int ADDITIONAL_BINDINGS_FIELD_NUMBER = 11;
private java.util.List additionalBindings_;
/**
*
*
*
* 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;
*/
@java.lang.Override
public java.util.List getAdditionalBindingsList() {
return additionalBindings_;
}
/**
*
*
*
* 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;
*/
@java.lang.Override
public java.util.List
getAdditionalBindingsOrBuilderList() {
return additionalBindings_;
}
/**
*
*
*
* 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;
*/
@java.lang.Override
public int getAdditionalBindingsCount() {
return additionalBindings_.size();
}
/**
*
*
*
* 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;
*/
@java.lang.Override
public com.google.api.HttpRule getAdditionalBindings(int index) {
return additionalBindings_.get(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;
*/
@java.lang.Override
public com.google.api.HttpRuleOrBuilder getAdditionalBindingsOrBuilder(int index) {
return additionalBindings_.get(index);
}
private byte memoizedIsInitialized = -1;
@java.lang.Override
public final boolean isInitialized() {
byte isInitialized = memoizedIsInitialized;
if (isInitialized == 1) return true;
if (isInitialized == 0) return false;
memoizedIsInitialized = 1;
return true;
}
@java.lang.Override
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException {
if (!getSelectorBytes().isEmpty()) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 1, selector_);
}
if (patternCase_ == 2) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 2, pattern_);
}
if (patternCase_ == 3) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 3, pattern_);
}
if (patternCase_ == 4) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 4, pattern_);
}
if (patternCase_ == 5) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 5, pattern_);
}
if (patternCase_ == 6) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 6, pattern_);
}
if (!getBodyBytes().isEmpty()) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 7, body_);
}
if (patternCase_ == 8) {
output.writeMessage(8, (com.google.api.CustomHttpPattern) pattern_);
}
for (int i = 0; i < additionalBindings_.size(); i++) {
output.writeMessage(11, additionalBindings_.get(i));
}
if (!getResponseBodyBytes().isEmpty()) {
com.google.protobuf.GeneratedMessageV3.writeString(output, 12, responseBody_);
}
unknownFields.writeTo(output);
}
@java.lang.Override
public int getSerializedSize() {
int size = memoizedSize;
if (size != -1) return size;
size = 0;
if (!getSelectorBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(1, selector_);
}
if (patternCase_ == 2) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(2, pattern_);
}
if (patternCase_ == 3) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(3, pattern_);
}
if (patternCase_ == 4) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(4, pattern_);
}
if (patternCase_ == 5) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(5, pattern_);
}
if (patternCase_ == 6) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(6, pattern_);
}
if (!getBodyBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(7, body_);
}
if (patternCase_ == 8) {
size +=
com.google.protobuf.CodedOutputStream.computeMessageSize(
8, (com.google.api.CustomHttpPattern) pattern_);
}
for (int i = 0; i < additionalBindings_.size(); i++) {
size +=
com.google.protobuf.CodedOutputStream.computeMessageSize(11, additionalBindings_.get(i));
}
if (!getResponseBodyBytes().isEmpty()) {
size += com.google.protobuf.GeneratedMessageV3.computeStringSize(12, responseBody_);
}
size += unknownFields.getSerializedSize();
memoizedSize = size;
return size;
}
@java.lang.Override
public boolean equals(final java.lang.Object obj) {
if (obj == this) {
return true;
}
if (!(obj instanceof com.google.api.HttpRule)) {
return super.equals(obj);
}
com.google.api.HttpRule other = (com.google.api.HttpRule) obj;
if (!getSelector().equals(other.getSelector())) return false;
if (!getBody().equals(other.getBody())) return false;
if (!getResponseBody().equals(other.getResponseBody())) return false;
if (!getAdditionalBindingsList().equals(other.getAdditionalBindingsList())) return false;
if (!getPatternCase().equals(other.getPatternCase())) return false;
switch (patternCase_) {
case 2:
if (!getGet().equals(other.getGet())) return false;
break;
case 3:
if (!getPut().equals(other.getPut())) return false;
break;
case 4:
if (!getPost().equals(other.getPost())) return false;
break;
case 5:
if (!getDelete().equals(other.getDelete())) return false;
break;
case 6:
if (!getPatch().equals(other.getPatch())) return false;
break;
case 8:
if (!getCustom().equals(other.getCustom())) return false;
break;
case 0:
default:
}
if (!unknownFields.equals(other.unknownFields)) return false;
return true;
}
@java.lang.Override
public int hashCode() {
if (memoizedHashCode != 0) {
return memoizedHashCode;
}
int hash = 41;
hash = (19 * hash) + getDescriptor().hashCode();
hash = (37 * hash) + SELECTOR_FIELD_NUMBER;
hash = (53 * hash) + getSelector().hashCode();
hash = (37 * hash) + BODY_FIELD_NUMBER;
hash = (53 * hash) + getBody().hashCode();
hash = (37 * hash) + RESPONSE_BODY_FIELD_NUMBER;
hash = (53 * hash) + getResponseBody().hashCode();
if (getAdditionalBindingsCount() > 0) {
hash = (37 * hash) + ADDITIONAL_BINDINGS_FIELD_NUMBER;
hash = (53 * hash) + getAdditionalBindingsList().hashCode();
}
switch (patternCase_) {
case 2:
hash = (37 * hash) + GET_FIELD_NUMBER;
hash = (53 * hash) + getGet().hashCode();
break;
case 3:
hash = (37 * hash) + PUT_FIELD_NUMBER;
hash = (53 * hash) + getPut().hashCode();
break;
case 4:
hash = (37 * hash) + POST_FIELD_NUMBER;
hash = (53 * hash) + getPost().hashCode();
break;
case 5:
hash = (37 * hash) + DELETE_FIELD_NUMBER;
hash = (53 * hash) + getDelete().hashCode();
break;
case 6:
hash = (37 * hash) + PATCH_FIELD_NUMBER;
hash = (53 * hash) + getPatch().hashCode();
break;
case 8:
hash = (37 * hash) + CUSTOM_FIELD_NUMBER;
hash = (53 * hash) + getCustom().hashCode();
break;
case 0:
default:
}
hash = (29 * hash) + unknownFields.hashCode();
memoizedHashCode = hash;
return hash;
}
public static com.google.api.HttpRule parseFrom(java.nio.ByteBuffer data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.HttpRule parseFrom(
java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.HttpRule parseFrom(com.google.protobuf.ByteString data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.HttpRule parseFrom(
com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.HttpRule parseFrom(byte[] data)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data);
}
public static com.google.api.HttpRule parseFrom(
byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return PARSER.parseFrom(data, extensionRegistry);
}
public static com.google.api.HttpRule parseFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.api.HttpRule parseFrom(
java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
PARSER, input, extensionRegistry);
}
public static com.google.api.HttpRule parseDelimitedFrom(java.io.InputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(PARSER, input);
}
public static com.google.api.HttpRule parseDelimitedFrom(
java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseDelimitedWithIOException(
PARSER, input, extensionRegistry);
}
public static com.google.api.HttpRule parseFrom(com.google.protobuf.CodedInputStream input)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(PARSER, input);
}
public static com.google.api.HttpRule parseFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
return com.google.protobuf.GeneratedMessageV3.parseWithIOException(
PARSER, input, extensionRegistry);
}
@java.lang.Override
public Builder newBuilderForType() {
return newBuilder();
}
public static Builder newBuilder() {
return DEFAULT_INSTANCE.toBuilder();
}
public static Builder newBuilder(com.google.api.HttpRule prototype) {
return DEFAULT_INSTANCE.toBuilder().mergeFrom(prototype);
}
@java.lang.Override
public Builder toBuilder() {
return this == DEFAULT_INSTANCE ? new Builder() : new Builder().mergeFrom(this);
}
@java.lang.Override
protected Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
Builder builder = new Builder(parent);
return builder;
}
/**
*
*
*
* # gRPC Transcoding
* gRPC Transcoding is a feature for mapping between a gRPC method and one or
* more HTTP REST endpoints. It allows developers to build a single API service
* that supports both gRPC APIs and REST APIs. Many systems, including [Google
* APIs](https://github.com/googleapis/googleapis),
* [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC
* Gateway](https://github.com/grpc-ecosystem/grpc-gateway),
* and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature
* and use it for large scale production services.
* `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies
* how different portions of the gRPC request message are mapped to the URL
* path, URL query parameters, and HTTP request body. It also controls how the
* gRPC response message is mapped to the HTTP response body. `HttpRule` is
* typically specified as an `google.api.http` annotation on the gRPC method.
* Each mapping specifies a URL path template and an HTTP method. The path
* template may refer to one or more fields in the gRPC request message, as long
* as each field is a non-repeated field with a primitive (non-message) type.
* The path template controls how fields of the request message are mapped to
* the URL path.
* Example:
* service Messaging {
* rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = {
* get: "/v1/{name=messages/*}"
* };
* }
* }
* message GetMessageRequest {
* string name = 1; // Mapped to URL path.
* }
* message Message {
* string text = 1; // The resource content.
* }
* This enables an HTTP REST to gRPC mapping as below:
* HTTP | gRPC
* -----|-----
* `GET /v1/messages/123456` | `GetMessage(name: "messages/123456")`
* Any fields in the request message which are not bound by the path template
* automatically become HTTP query parameters if there is no HTTP request body.
* For example:
* service Messaging {
* rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = {
* get:"/v1/messages/{message_id}"
* };
* }
* }
* message GetMessageRequest {
* message SubMessage {
* string subfield = 1;
* }
* string message_id = 1; // Mapped to URL path.
* int64 revision = 2; // Mapped to URL query parameter `revision`.
* SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`.
* }
* This enables a HTTP JSON to RPC mapping as below:
* HTTP | gRPC
* -----|-----
* `GET /v1/messages/123456?revision=2&sub.subfield=foo` |
* `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield:
* "foo"))`
* Note that fields which are mapped to URL query parameters must have a
* primitive type or a repeated primitive type or a non-repeated message type.
* In the case of a repeated type, the parameter can be repeated in the URL
* as `...?param=A¶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 | gRPC
* -----|-----
* `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
* "123456" message { text: "Hi!" })`
* The special name `*` can be used in the body mapping to define that
* every field not bound by the path template should be mapped to the
* request body. This enables the following alternative definition of
* the update method:
* service Messaging {
* rpc UpdateMessage(Message) returns (Message) {
* option (google.api.http) = {
* patch: "/v1/messages/{message_id}"
* body: "*"
* };
* }
* }
* message Message {
* string message_id = 1;
* string text = 2;
* }
* The following HTTP JSON to RPC mapping is enabled:
* HTTP | gRPC
* -----|-----
* `PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id:
* "123456" text: "Hi!")`
* Note that when using `*` in the body mapping, it is not possible to
* have HTTP parameters, as all fields not bound by the path end in
* the body. This makes this option more rarely used in practice when
* defining REST APIs. The common usage of `*` is in custom methods
* which don't use the URL at all for transferring data.
* It is possible to define multiple HTTP methods for one RPC by using
* the `additional_bindings` option. Example:
* service Messaging {
* rpc GetMessage(GetMessageRequest) returns (Message) {
* option (google.api.http) = {
* get: "/v1/messages/{message_id}"
* additional_bindings {
* get: "/v1/users/{user_id}/messages/{message_id}"
* }
* };
* }
* }
* message GetMessageRequest {
* string message_id = 1;
* string user_id = 2;
* }
* This enables the following two alternative HTTP JSON to RPC mappings:
* HTTP | gRPC
* -----|-----
* `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
* `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id:
* "123456")`
* ## Rules for HTTP mapping
* 1. Leaf request fields (recursive expansion nested messages in the request
* message) are classified into three categories:
* - Fields referred by the path template. They are passed via the URL path.
* - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP
* request body.
* - All other fields are passed via the URL query parameters, and the
* parameter name is the field path in the request message. A repeated
* field can be represented as multiple query parameters under the same
* name.
* 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields
* are passed via URL path and HTTP request body.
* 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all
* fields are passed via URL path and URL query parameters.
* ### Path template syntax
* Template = "/" Segments [ Verb ] ;
* Segments = Segment { "/" Segment } ;
* Segment = "*" | "**" | LITERAL | Variable ;
* Variable = "{" FieldPath [ "=" Segments ] "}" ;
* FieldPath = IDENT { "." IDENT } ;
* Verb = ":" LITERAL ;
* The syntax `*` matches a single URL path segment. The syntax `**` matches
* zero or more URL path segments, which must be the last part of the URL path
* except the `Verb`.
* The syntax `Variable` matches part of the URL path as specified by its
* template. A variable template must not contain other variables. If a variable
* matches a single path segment, its template may be omitted, e.g. `{var}`
* is equivalent to `{var=*}`.
* The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL`
* contains any reserved character, such characters should be percent-encoded
* before the matching.
* If a variable contains exactly one path segment, such as `"{var}"` or
* `"{var=*}"`, when such a variable is expanded into a URL path on the client
* side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The
* server side does the reverse decoding. Such variables show up in the
* [Discovery
* Document](https://developers.google.com/discovery/v1/reference/apis) as
* `{var}`.
* If a variable contains multiple path segments, such as `"{var=foo/*}"`
* or `"{var=**}"`, when such a variable is expanded into a URL path on the
* client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded.
* The server side does the reverse decoding, except "%2F" and "%2f" are left
* unchanged. Such variables show up in the
* [Discovery
* Document](https://developers.google.com/discovery/v1/reference/apis) as
* `{+var}`.
* ## Using gRPC API Service Configuration
* gRPC API Service Configuration (service config) is a configuration language
* for configuring a gRPC service to become a user-facing product. The
* service config is simply the YAML representation of the `google.api.Service`
* proto message.
* As an alternative to annotating your proto file, you can configure gRPC
* transcoding in your service config YAML files. You do this by specifying a
* `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same
* effect as the proto annotation. This can be particularly useful if you
* have a proto that is reused in multiple services. Note that any transcoding
* specified in the service config will override any matching transcoding
* configuration in the proto.
* Example:
* http:
* rules:
* # Selects a gRPC method and applies HttpRule to it.
* - selector: example.v1.Messaging.GetMessage
* get: /v1/messages/{message_id}/{sub.subfield}
* ## Special notes
* When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the
* proto to JSON conversion must follow the [proto3
* specification](https://developers.google.com/protocol-buffers/docs/proto3#json).
* While the single segment variable follows the semantics of
* [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String
* Expansion, the multi segment variable **does not** follow RFC 6570 Section
* 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion
* does not expand special characters like `?` and `#`, which would lead
* to invalid URLs. As the result, gRPC Transcoding uses a custom encoding
* for multi segment variables.
* The path variables **must not** refer to any repeated or mapped field,
* because client libraries are not capable of handling such variable expansion.
* The path variables **must not** capture the leading "/" character. The reason
* is that the most common use case "{var}" does not capture the leading "/"
* character. For consistency, all path variables must share the same behavior.
* Repeated message fields must not be mapped to URL query parameters, because
* no client library can support such complicated mapping.
* If an API needs to use a JSON array for request or response body, it can map
* the request or response body to a repeated field. However, some gRPC
* Transcoding implementations may not support this feature.
*
*
* Protobuf type {@code google.api.HttpRule}
*/
public static final class Builder extends com.google.protobuf.GeneratedMessageV3.Builder
implements
// @@protoc_insertion_point(builder_implements:google.api.HttpRule)
com.google.api.HttpRuleOrBuilder {
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
return com.google.api.HttpProto.internal_static_google_api_HttpRule_descriptor;
}
@java.lang.Override
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable() {
return com.google.api.HttpProto.internal_static_google_api_HttpRule_fieldAccessorTable
.ensureFieldAccessorsInitialized(
com.google.api.HttpRule.class, com.google.api.HttpRule.Builder.class);
}
// Construct using com.google.api.HttpRule.newBuilder()
private Builder() {
maybeForceBuilderInitialization();
}
private Builder(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) {
super(parent);
maybeForceBuilderInitialization();
}
private void maybeForceBuilderInitialization() {
if (com.google.protobuf.GeneratedMessageV3.alwaysUseFieldBuilders) {
getAdditionalBindingsFieldBuilder();
}
}
@java.lang.Override
public Builder clear() {
super.clear();
selector_ = "";
body_ = "";
responseBody_ = "";
if (additionalBindingsBuilder_ == null) {
additionalBindings_ = java.util.Collections.emptyList();
bitField0_ = (bitField0_ & ~0x00000001);
} else {
additionalBindingsBuilder_.clear();
}
patternCase_ = 0;
pattern_ = null;
return this;
}
@java.lang.Override
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType() {
return com.google.api.HttpProto.internal_static_google_api_HttpRule_descriptor;
}
@java.lang.Override
public com.google.api.HttpRule getDefaultInstanceForType() {
return com.google.api.HttpRule.getDefaultInstance();
}
@java.lang.Override
public com.google.api.HttpRule build() {
com.google.api.HttpRule result = buildPartial();
if (!result.isInitialized()) {
throw newUninitializedMessageException(result);
}
return result;
}
@java.lang.Override
public com.google.api.HttpRule buildPartial() {
com.google.api.HttpRule result = new com.google.api.HttpRule(this);
int from_bitField0_ = bitField0_;
result.selector_ = selector_;
if (patternCase_ == 2) {
result.pattern_ = pattern_;
}
if (patternCase_ == 3) {
result.pattern_ = pattern_;
}
if (patternCase_ == 4) {
result.pattern_ = pattern_;
}
if (patternCase_ == 5) {
result.pattern_ = pattern_;
}
if (patternCase_ == 6) {
result.pattern_ = pattern_;
}
if (patternCase_ == 8) {
if (customBuilder_ == null) {
result.pattern_ = pattern_;
} else {
result.pattern_ = customBuilder_.build();
}
}
result.body_ = body_;
result.responseBody_ = responseBody_;
if (additionalBindingsBuilder_ == null) {
if (((bitField0_ & 0x00000001) != 0)) {
additionalBindings_ = java.util.Collections.unmodifiableList(additionalBindings_);
bitField0_ = (bitField0_ & ~0x00000001);
}
result.additionalBindings_ = additionalBindings_;
} else {
result.additionalBindings_ = additionalBindingsBuilder_.build();
}
result.patternCase_ = patternCase_;
onBuilt();
return result;
}
@java.lang.Override
public Builder clone() {
return super.clone();
}
@java.lang.Override
public Builder setField(
com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) {
return super.setField(field, value);
}
@java.lang.Override
public Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) {
return super.clearField(field);
}
@java.lang.Override
public Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) {
return super.clearOneof(oneof);
}
@java.lang.Override
public Builder setRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value) {
return super.setRepeatedField(field, index, value);
}
@java.lang.Override
public Builder addRepeatedField(
com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value) {
return super.addRepeatedField(field, value);
}
@java.lang.Override
public Builder mergeFrom(com.google.protobuf.Message other) {
if (other instanceof com.google.api.HttpRule) {
return mergeFrom((com.google.api.HttpRule) other);
} else {
super.mergeFrom(other);
return this;
}
}
public Builder mergeFrom(com.google.api.HttpRule other) {
if (other == com.google.api.HttpRule.getDefaultInstance()) return this;
if (!other.getSelector().isEmpty()) {
selector_ = other.selector_;
onChanged();
}
if (!other.getBody().isEmpty()) {
body_ = other.body_;
onChanged();
}
if (!other.getResponseBody().isEmpty()) {
responseBody_ = other.responseBody_;
onChanged();
}
if (additionalBindingsBuilder_ == null) {
if (!other.additionalBindings_.isEmpty()) {
if (additionalBindings_.isEmpty()) {
additionalBindings_ = other.additionalBindings_;
bitField0_ = (bitField0_ & ~0x00000001);
} else {
ensureAdditionalBindingsIsMutable();
additionalBindings_.addAll(other.additionalBindings_);
}
onChanged();
}
} else {
if (!other.additionalBindings_.isEmpty()) {
if (additionalBindingsBuilder_.isEmpty()) {
additionalBindingsBuilder_.dispose();
additionalBindingsBuilder_ = null;
additionalBindings_ = other.additionalBindings_;
bitField0_ = (bitField0_ & ~0x00000001);
additionalBindingsBuilder_ =
com.google.protobuf.GeneratedMessageV3.alwaysUseFieldBuilders
? getAdditionalBindingsFieldBuilder()
: null;
} else {
additionalBindingsBuilder_.addAllMessages(other.additionalBindings_);
}
}
}
switch (other.getPatternCase()) {
case GET:
{
patternCase_ = 2;
pattern_ = other.pattern_;
onChanged();
break;
}
case PUT:
{
patternCase_ = 3;
pattern_ = other.pattern_;
onChanged();
break;
}
case POST:
{
patternCase_ = 4;
pattern_ = other.pattern_;
onChanged();
break;
}
case DELETE:
{
patternCase_ = 5;
pattern_ = other.pattern_;
onChanged();
break;
}
case PATCH:
{
patternCase_ = 6;
pattern_ = other.pattern_;
onChanged();
break;
}
case CUSTOM:
{
mergeCustom(other.getCustom());
break;
}
case PATTERN_NOT_SET:
{
break;
}
}
this.mergeUnknownFields(other.unknownFields);
onChanged();
return this;
}
@java.lang.Override
public final boolean isInitialized() {
return true;
}
@java.lang.Override
public Builder mergeFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws java.io.IOException {
com.google.api.HttpRule parsedMessage = null;
try {
parsedMessage = PARSER.parsePartialFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
parsedMessage = (com.google.api.HttpRule) e.getUnfinishedMessage();
throw e.unwrapIOException();
} finally {
if (parsedMessage != null) {
mergeFrom(parsedMessage);
}
}
return this;
}
private int patternCase_ = 0;
private java.lang.Object pattern_;
public PatternCase getPatternCase() {
return PatternCase.forNumber(patternCase_);
}
public Builder clearPattern() {
patternCase_ = 0;
pattern_ = null;
onChanged();
return this;
}
private int bitField0_;
private java.lang.Object selector_ = "";
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @return The selector.
*/
public java.lang.String getSelector() {
java.lang.Object ref = selector_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
selector_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @return The bytes for selector.
*/
public com.google.protobuf.ByteString getSelectorBytes() {
java.lang.Object ref = selector_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
selector_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @param value The selector to set.
* @return This builder for chaining.
*/
public Builder setSelector(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
selector_ = value;
onChanged();
return this;
}
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @return This builder for chaining.
*/
public Builder clearSelector() {
selector_ = getDefaultInstance().getSelector();
onChanged();
return this;
}
/**
*
*
*
* Selects a method to which this rule applies.
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
*
*
* string selector = 1;
*
* @param value The bytes for selector to set.
* @return This builder for chaining.
*/
public Builder setSelectorBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
selector_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @return The get.
*/
@java.lang.Override
public java.lang.String getGet() {
java.lang.Object ref = "";
if (patternCase_ == 2) {
ref = pattern_;
}
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 2) {
pattern_ = s;
}
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @return The bytes for get.
*/
@java.lang.Override
public com.google.protobuf.ByteString getGetBytes() {
java.lang.Object ref = "";
if (patternCase_ == 2) {
ref = pattern_;
}
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 2) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @param value The get to set.
* @return This builder for chaining.
*/
public Builder setGet(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
patternCase_ = 2;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @return This builder for chaining.
*/
public Builder clearGet() {
if (patternCase_ == 2) {
patternCase_ = 0;
pattern_ = null;
onChanged();
}
return this;
}
/**
*
*
*
* Maps to HTTP GET. Used for listing and getting information about
* resources.
*
*
* string get = 2;
*
* @param value The bytes for get to set.
* @return This builder for chaining.
*/
public Builder setGetBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
patternCase_ = 2;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @return The put.
*/
@java.lang.Override
public java.lang.String getPut() {
java.lang.Object ref = "";
if (patternCase_ == 3) {
ref = pattern_;
}
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 3) {
pattern_ = s;
}
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @return The bytes for put.
*/
@java.lang.Override
public com.google.protobuf.ByteString getPutBytes() {
java.lang.Object ref = "";
if (patternCase_ == 3) {
ref = pattern_;
}
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 3) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @param value The put to set.
* @return This builder for chaining.
*/
public Builder setPut(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
patternCase_ = 3;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @return This builder for chaining.
*/
public Builder clearPut() {
if (patternCase_ == 3) {
patternCase_ = 0;
pattern_ = null;
onChanged();
}
return this;
}
/**
*
*
*
* Maps to HTTP PUT. Used for replacing a resource.
*
*
* string put = 3;
*
* @param value The bytes for put to set.
* @return This builder for chaining.
*/
public Builder setPutBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
patternCase_ = 3;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @return The post.
*/
@java.lang.Override
public java.lang.String getPost() {
java.lang.Object ref = "";
if (patternCase_ == 4) {
ref = pattern_;
}
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 4) {
pattern_ = s;
}
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @return The bytes for post.
*/
@java.lang.Override
public com.google.protobuf.ByteString getPostBytes() {
java.lang.Object ref = "";
if (patternCase_ == 4) {
ref = pattern_;
}
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 4) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @param value The post to set.
* @return This builder for chaining.
*/
public Builder setPost(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
patternCase_ = 4;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @return This builder for chaining.
*/
public Builder clearPost() {
if (patternCase_ == 4) {
patternCase_ = 0;
pattern_ = null;
onChanged();
}
return this;
}
/**
*
*
*
* Maps to HTTP POST. Used for creating a resource or performing an action.
*
*
* string post = 4;
*
* @param value The bytes for post to set.
* @return This builder for chaining.
*/
public Builder setPostBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
patternCase_ = 4;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @return The delete.
*/
@java.lang.Override
public java.lang.String getDelete() {
java.lang.Object ref = "";
if (patternCase_ == 5) {
ref = pattern_;
}
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 5) {
pattern_ = s;
}
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @return The bytes for delete.
*/
@java.lang.Override
public com.google.protobuf.ByteString getDeleteBytes() {
java.lang.Object ref = "";
if (patternCase_ == 5) {
ref = pattern_;
}
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 5) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @param value The delete to set.
* @return This builder for chaining.
*/
public Builder setDelete(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
patternCase_ = 5;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @return This builder for chaining.
*/
public Builder clearDelete() {
if (patternCase_ == 5) {
patternCase_ = 0;
pattern_ = null;
onChanged();
}
return this;
}
/**
*
*
*
* Maps to HTTP DELETE. Used for deleting a resource.
*
*
* string delete = 5;
*
* @param value The bytes for delete to set.
* @return This builder for chaining.
*/
public Builder setDeleteBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
patternCase_ = 5;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @return The patch.
*/
@java.lang.Override
public java.lang.String getPatch() {
java.lang.Object ref = "";
if (patternCase_ == 6) {
ref = pattern_;
}
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
if (patternCase_ == 6) {
pattern_ = s;
}
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @return The bytes for patch.
*/
@java.lang.Override
public com.google.protobuf.ByteString getPatchBytes() {
java.lang.Object ref = "";
if (patternCase_ == 6) {
ref = pattern_;
}
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
if (patternCase_ == 6) {
pattern_ = b;
}
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @param value The patch to set.
* @return This builder for chaining.
*/
public Builder setPatch(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
patternCase_ = 6;
pattern_ = value;
onChanged();
return this;
}
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @return This builder for chaining.
*/
public Builder clearPatch() {
if (patternCase_ == 6) {
patternCase_ = 0;
pattern_ = null;
onChanged();
}
return this;
}
/**
*
*
*
* Maps to HTTP PATCH. Used for updating a resource.
*
*
* string patch = 6;
*
* @param value The bytes for patch to set.
* @return This builder for chaining.
*/
public Builder setPatchBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
patternCase_ = 6;
pattern_ = value;
onChanged();
return this;
}
private com.google.protobuf.SingleFieldBuilderV3<
com.google.api.CustomHttpPattern,
com.google.api.CustomHttpPattern.Builder,
com.google.api.CustomHttpPatternOrBuilder>
customBuilder_;
/**
*
*
*
* 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;
*
* @return Whether the custom field is set.
*/
@java.lang.Override
public boolean hasCustom() {
return patternCase_ == 8;
}
/**
*
*
*
* 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;
*
* @return The custom.
*/
@java.lang.Override
public com.google.api.CustomHttpPattern getCustom() {
if (customBuilder_ == null) {
if (patternCase_ == 8) {
return (com.google.api.CustomHttpPattern) pattern_;
}
return com.google.api.CustomHttpPattern.getDefaultInstance();
} else {
if (patternCase_ == 8) {
return customBuilder_.getMessage();
}
return com.google.api.CustomHttpPattern.getDefaultInstance();
}
}
/**
*
*
*
* 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;
*/
public Builder setCustom(com.google.api.CustomHttpPattern value) {
if (customBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
pattern_ = value;
onChanged();
} else {
customBuilder_.setMessage(value);
}
patternCase_ = 8;
return this;
}
/**
*
*
*
* 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;
*/
public Builder setCustom(com.google.api.CustomHttpPattern.Builder builderForValue) {
if (customBuilder_ == null) {
pattern_ = builderForValue.build();
onChanged();
} else {
customBuilder_.setMessage(builderForValue.build());
}
patternCase_ = 8;
return this;
}
/**
*
*
*
* 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;
*/
public Builder mergeCustom(com.google.api.CustomHttpPattern value) {
if (customBuilder_ == null) {
if (patternCase_ == 8
&& pattern_ != com.google.api.CustomHttpPattern.getDefaultInstance()) {
pattern_ =
com.google.api.CustomHttpPattern.newBuilder(
(com.google.api.CustomHttpPattern) pattern_)
.mergeFrom(value)
.buildPartial();
} else {
pattern_ = value;
}
onChanged();
} else {
if (patternCase_ == 8) {
customBuilder_.mergeFrom(value);
}
customBuilder_.setMessage(value);
}
patternCase_ = 8;
return this;
}
/**
*
*
*
* 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;
*/
public Builder clearCustom() {
if (customBuilder_ == null) {
if (patternCase_ == 8) {
patternCase_ = 0;
pattern_ = null;
onChanged();
}
} else {
if (patternCase_ == 8) {
patternCase_ = 0;
pattern_ = null;
}
customBuilder_.clear();
}
return this;
}
/**
*
*
*
* 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;
*/
public com.google.api.CustomHttpPattern.Builder getCustomBuilder() {
return getCustomFieldBuilder().getBuilder();
}
/**
*
*
*
* 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;
*/
@java.lang.Override
public com.google.api.CustomHttpPatternOrBuilder getCustomOrBuilder() {
if ((patternCase_ == 8) && (customBuilder_ != null)) {
return customBuilder_.getMessageOrBuilder();
} else {
if (patternCase_ == 8) {
return (com.google.api.CustomHttpPattern) pattern_;
}
return com.google.api.CustomHttpPattern.getDefaultInstance();
}
}
/**
*
*
*
* 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;
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.api.CustomHttpPattern,
com.google.api.CustomHttpPattern.Builder,
com.google.api.CustomHttpPatternOrBuilder>
getCustomFieldBuilder() {
if (customBuilder_ == null) {
if (!(patternCase_ == 8)) {
pattern_ = com.google.api.CustomHttpPattern.getDefaultInstance();
}
customBuilder_ =
new com.google.protobuf.SingleFieldBuilderV3<
com.google.api.CustomHttpPattern,
com.google.api.CustomHttpPattern.Builder,
com.google.api.CustomHttpPatternOrBuilder>(
(com.google.api.CustomHttpPattern) pattern_, getParentForChildren(), isClean());
pattern_ = null;
}
patternCase_ = 8;
onChanged();
;
return customBuilder_;
}
private java.lang.Object body_ = "";
/**
*
*
*
* 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;
*
* @return The body.
*/
public java.lang.String getBody() {
java.lang.Object ref = body_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
body_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* 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;
*
* @return The bytes for body.
*/
public com.google.protobuf.ByteString getBodyBytes() {
java.lang.Object ref = body_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
body_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* 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;
*
* @param value The body to set.
* @return This builder for chaining.
*/
public Builder setBody(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
body_ = value;
onChanged();
return this;
}
/**
*
*
*
* 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;
*
* @return This builder for chaining.
*/
public Builder clearBody() {
body_ = getDefaultInstance().getBody();
onChanged();
return this;
}
/**
*
*
*
* 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;
*
* @param value The bytes for body to set.
* @return This builder for chaining.
*/
public Builder setBodyBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
body_ = value;
onChanged();
return this;
}
private java.lang.Object responseBody_ = "";
/**
*
*
*
* 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;
*
* @return The responseBody.
*/
public java.lang.String getResponseBody() {
java.lang.Object ref = responseBody_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
responseBody_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* 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;
*
* @return The bytes for responseBody.
*/
public com.google.protobuf.ByteString getResponseBodyBytes() {
java.lang.Object ref = responseBody_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
responseBody_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* 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;
*
* @param value The responseBody to set.
* @return This builder for chaining.
*/
public Builder setResponseBody(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
responseBody_ = value;
onChanged();
return this;
}
/**
*
*
*
* 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;
*
* @return This builder for chaining.
*/
public Builder clearResponseBody() {
responseBody_ = getDefaultInstance().getResponseBody();
onChanged();
return this;
}
/**
*
*
*
* 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;
*
* @param value The bytes for responseBody to set.
* @return This builder for chaining.
*/
public Builder setResponseBodyBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
responseBody_ = value;
onChanged();
return this;
}
private java.util.List additionalBindings_ =
java.util.Collections.emptyList();
private void ensureAdditionalBindingsIsMutable() {
if (!((bitField0_ & 0x00000001) != 0)) {
additionalBindings_ = new java.util.ArrayList(additionalBindings_);
bitField0_ |= 0x00000001;
}
}
private com.google.protobuf.RepeatedFieldBuilderV3<
com.google.api.HttpRule,
com.google.api.HttpRule.Builder,
com.google.api.HttpRuleOrBuilder>
additionalBindingsBuilder_;
/**
*
*
*
* 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;
*/
public java.util.List getAdditionalBindingsList() {
if (additionalBindingsBuilder_ == null) {
return java.util.Collections.unmodifiableList(additionalBindings_);
} else {
return additionalBindingsBuilder_.getMessageList();
}
}
/**
*
*
*
* 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;
*/
public int getAdditionalBindingsCount() {
if (additionalBindingsBuilder_ == null) {
return additionalBindings_.size();
} else {
return additionalBindingsBuilder_.getCount();
}
}
/**
*
*
*
* 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;
*/
public com.google.api.HttpRule getAdditionalBindings(int index) {
if (additionalBindingsBuilder_ == null) {
return additionalBindings_.get(index);
} else {
return additionalBindingsBuilder_.getMessage(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;
*/
public Builder setAdditionalBindings(int index, com.google.api.HttpRule value) {
if (additionalBindingsBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
ensureAdditionalBindingsIsMutable();
additionalBindings_.set(index, value);
onChanged();
} else {
additionalBindingsBuilder_.setMessage(index, value);
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder setAdditionalBindings(
int index, com.google.api.HttpRule.Builder builderForValue) {
if (additionalBindingsBuilder_ == null) {
ensureAdditionalBindingsIsMutable();
additionalBindings_.set(index, builderForValue.build());
onChanged();
} else {
additionalBindingsBuilder_.setMessage(index, builderForValue.build());
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder addAdditionalBindings(com.google.api.HttpRule value) {
if (additionalBindingsBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
ensureAdditionalBindingsIsMutable();
additionalBindings_.add(value);
onChanged();
} else {
additionalBindingsBuilder_.addMessage(value);
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder addAdditionalBindings(int index, com.google.api.HttpRule value) {
if (additionalBindingsBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
ensureAdditionalBindingsIsMutable();
additionalBindings_.add(index, value);
onChanged();
} else {
additionalBindingsBuilder_.addMessage(index, value);
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder addAdditionalBindings(com.google.api.HttpRule.Builder builderForValue) {
if (additionalBindingsBuilder_ == null) {
ensureAdditionalBindingsIsMutable();
additionalBindings_.add(builderForValue.build());
onChanged();
} else {
additionalBindingsBuilder_.addMessage(builderForValue.build());
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder addAdditionalBindings(
int index, com.google.api.HttpRule.Builder builderForValue) {
if (additionalBindingsBuilder_ == null) {
ensureAdditionalBindingsIsMutable();
additionalBindings_.add(index, builderForValue.build());
onChanged();
} else {
additionalBindingsBuilder_.addMessage(index, builderForValue.build());
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder addAllAdditionalBindings(
java.lang.Iterable values) {
if (additionalBindingsBuilder_ == null) {
ensureAdditionalBindingsIsMutable();
com.google.protobuf.AbstractMessageLite.Builder.addAll(values, additionalBindings_);
onChanged();
} else {
additionalBindingsBuilder_.addAllMessages(values);
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder clearAdditionalBindings() {
if (additionalBindingsBuilder_ == null) {
additionalBindings_ = java.util.Collections.emptyList();
bitField0_ = (bitField0_ & ~0x00000001);
onChanged();
} else {
additionalBindingsBuilder_.clear();
}
return this;
}
/**
*
*
*
* 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;
*/
public Builder removeAdditionalBindings(int index) {
if (additionalBindingsBuilder_ == null) {
ensureAdditionalBindingsIsMutable();
additionalBindings_.remove(index);
onChanged();
} else {
additionalBindingsBuilder_.remove(index);
}
return this;
}
/**
*
*
*
* 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;
*/
public com.google.api.HttpRule.Builder getAdditionalBindingsBuilder(int index) {
return getAdditionalBindingsFieldBuilder().getBuilder(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;
*/
public com.google.api.HttpRuleOrBuilder getAdditionalBindingsOrBuilder(int index) {
if (additionalBindingsBuilder_ == null) {
return additionalBindings_.get(index);
} else {
return additionalBindingsBuilder_.getMessageOrBuilder(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;
*/
public java.util.List
getAdditionalBindingsOrBuilderList() {
if (additionalBindingsBuilder_ != null) {
return additionalBindingsBuilder_.getMessageOrBuilderList();
} else {
return java.util.Collections.unmodifiableList(additionalBindings_);
}
}
/**
*
*
*
* 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;
*/
public com.google.api.HttpRule.Builder addAdditionalBindingsBuilder() {
return getAdditionalBindingsFieldBuilder()
.addBuilder(com.google.api.HttpRule.getDefaultInstance());
}
/**
*
*
*
* 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;
*/
public com.google.api.HttpRule.Builder addAdditionalBindingsBuilder(int index) {
return getAdditionalBindingsFieldBuilder()
.addBuilder(index, com.google.api.HttpRule.getDefaultInstance());
}
/**
*
*
*
* 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;
*/
public java.util.List getAdditionalBindingsBuilderList() {
return getAdditionalBindingsFieldBuilder().getBuilderList();
}
private com.google.protobuf.RepeatedFieldBuilderV3<
com.google.api.HttpRule,
com.google.api.HttpRule.Builder,
com.google.api.HttpRuleOrBuilder>
getAdditionalBindingsFieldBuilder() {
if (additionalBindingsBuilder_ == null) {
additionalBindingsBuilder_ =
new com.google.protobuf.RepeatedFieldBuilderV3<
com.google.api.HttpRule,
com.google.api.HttpRule.Builder,
com.google.api.HttpRuleOrBuilder>(
additionalBindings_,
((bitField0_ & 0x00000001) != 0),
getParentForChildren(),
isClean());
additionalBindings_ = null;
}
return additionalBindingsBuilder_;
}
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:google.api.HttpRule)
}
// @@protoc_insertion_point(class_scope:google.api.HttpRule)
private static final com.google.api.HttpRule DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.google.api.HttpRule();
}
public static com.google.api.HttpRule getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser PARSER =
new com.google.protobuf.AbstractParser() {
@java.lang.Override
public HttpRule parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
return new HttpRule(input, extensionRegistry);
}
};
public static com.google.protobuf.Parser parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser getParserForType() {
return PARSER;
}
@java.lang.Override
public com.google.api.HttpRule getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}