Package com.google.api

Class HttpRule.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>
com.google.api.HttpRule.Builder
All Implemented Interfaces:
HttpRuleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
HttpRule
public static final class HttpRule.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder> implements HttpRuleOrBuilder
 `HttpRule` defines the mapping of an RPC method to one or more HTTP
 REST API methods. The mapping specifies how different portions of the RPC
 request message are mapped to URL path, URL query parameters, and
 HTTP request body. The mapping is typically specified as an
 `google.api.http` annotation on the RPC method,
 see "google/api/annotations.proto" for details.
 The mapping consists of a field specifying the path template and
 method kind.  The path template can refer to fields in the request
 message, as in the example below which describes a REST GET
 operation on a resource collection of messages:
     service Messaging {
       rpc GetMessage(GetMessageRequest) returns (Message) {
         option (google.api.http).get = "/v1/messages/{message_id}/{sub.subfield}";
       }
     }
     message GetMessageRequest {
       message SubMessage {
         string subfield = 1;
       }
       string message_id = 1; // mapped to the URL
       SubMessage sub = 2;    // `sub.subfield` is url-mapped
     }
     message Message {
       string text = 1; // content of the resource
     }
 The same http annotation can alternatively be expressed inside the
 `GRPC API Configuration` YAML file.
     http:
       rules:
         - selector: <proto_package_name>.Messaging.GetMessage
           get: /v1/messages/{message_id}/{sub.subfield}
 This definition enables an automatic, bidrectional mapping of HTTP
 JSON to RPC. Example:
 HTTP | RPC
 -----|-----
 `GET /v1/messages/123456/foo`  | `GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo"))`
 In general, not only fields but also field paths can be referenced
 from a path pattern. Fields mapped to the path pattern cannot be
 repeated and must have a primitive (non-message) type.
 Any fields in the request message which are not bound by the path
 pattern automatically become (optional) HTTP query
 parameters. Assume the following definition of the request message:
     service Messaging {
       rpc GetMessage(GetMessageRequest) returns (Message) {
         option (google.api.http).get = "/v1/messages/{message_id}";
       }
     }
     message GetMessageRequest {
       message SubMessage {
         string subfield = 1;
       }
       string message_id = 1; // mapped to the URL
       int64 revision = 2;    // becomes a parameter
       SubMessage sub = 3;    // `sub.subfield` becomes a parameter
     }
 This enables a HTTP JSON to RPC mapping as below:
 HTTP | RPC
 -----|-----
 `GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))`
 Note that fields which are mapped to HTTP parameters must have a
 primitive type or a repeated primitive type. Message types are not
 allowed. In the case of a repeated type, the parameter can be
 repeated in the URL, as in `...?param=A&param=B`.
 For HTTP method kinds which allow a request body, the `body` field
 specifies the mapping. Consider a REST update method on the
 message resource collection:
     service Messaging {
       rpc UpdateMessage(UpdateMessageRequest) returns (Message) {
         option (google.api.http) = {
           put: "/v1/messages/{message_id}"
           body: "message"
         };
       }
     }
     message UpdateMessageRequest {
       string message_id = 1; // mapped to the URL
       Message message = 2;   // mapped to the body
     }
 The following HTTP JSON to RPC mapping is enabled, where the
 representation of the JSON in the request body is determined by
 protos JSON encoding:
 HTTP | RPC
 -----|-----
 `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" message { text: "Hi!" })`
 The special name `*` can be used in the body mapping to define that
 every field not bound by the path template should be mapped to the
 request body.  This enables the following alternative definition of
 the update method:
     service Messaging {
       rpc UpdateMessage(Message) returns (Message) {
         option (google.api.http) = {
           put: "/v1/messages/{message_id}"
           body: "*"
         };
       }
     }
     message Message {
       string message_id = 1;
       string text = 2;
     }
 The following HTTP JSON to RPC mapping is enabled:
 HTTP | RPC
 -----|-----
 `PUT /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: "123456" text: "Hi!")`
 Note that when using `*` in the body mapping, it is not possible to
 have HTTP parameters, as all fields not bound by the path end in
 the body. This makes this option more rarely used in practice of
 defining REST APIs. The common usage of `*` is in custom methods
 which don't use the URL at all for transferring data.
 It is possible to define multiple HTTP methods for one RPC by using
 the `additional_bindings` option. Example:
     service Messaging {
       rpc GetMessage(GetMessageRequest) returns (Message) {
         option (google.api.http) = {
           get: "/v1/messages/{message_id}"
           additional_bindings {
             get: "/v1/users/{user_id}/messages/{message_id}"
           }
         };
       }
     }
     message GetMessageRequest {
       string message_id = 1;
       string user_id = 2;
     }
 This enables the following two alternative HTTP JSON to RPC
 mappings:
 HTTP | RPC
 -----|-----
 `GET /v1/messages/123456` | `GetMessage(message_id: "123456")`
 `GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: "123456")`
 # Rules for HTTP mapping
 The rules for mapping HTTP path, query parameters, and body fields
 to the request message are as follows:
 1. The `body` field specifies either `*` or a field path, or is
    omitted. If omitted, it indicates there is no HTTP request body.
 2. Leaf fields (recursive expansion of nested messages in the
    request) can be classified into three types:
     (a) Matched in the URL template.
     (b) Covered by body (if body is `*`, everything except (a) fields;
         else everything under the body field)
     (c) All other fields.
 3. URL query parameters found in the HTTP request are mapped to (c) fields.
 4. Any body sent with an HTTP request can contain only (b) fields.
 The syntax of the path template is as follows:
     Template = "/" Segments [ Verb ] ;
     Segments = Segment { "/" Segment } ;
     Segment  = "*" | "**" | LITERAL | Variable ;
     Variable = "{" FieldPath [ "=" Segments ] "}" ;
     FieldPath = IDENT { "." IDENT } ;
     Verb     = ":" LITERAL ;
 The syntax `*` matches a single path segment. The syntax `**` matches zero
 or more path segments, which must be the last part of the path except the
 `Verb`. The syntax `LITERAL` matches literal text in the path.
 The syntax `Variable` matches part of the URL path as specified by its
 template. A variable template must not contain other variables. If a variable
 matches a single path segment, its template may be omitted, e.g. `{var}`
 is equivalent to `{var=*}`.
 If a variable contains exactly one path segment, such as `"{var}"` or
 `"{var=*}"`, when such a variable is expanded into a URL path, all characters
 except `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the
 Discovery Document as `{var}`.
 If a variable contains one or more path segments, such as `"{var=foo/*}"`
 or `"{var=**}"`, when such a variable is expanded into a URL path, all
 characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables
 show up in the Discovery Document as `{+var}`.
 NOTE: While the single segment variable matches the semantics of
 [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2
 Simple String Expansion, the multi segment variable **does not** match
 RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion
 does not expand special characters like `?` and `#`, which would lead
 to invalid URLs.
 NOTE: the field paths in variables and in the `body` must not refer to
 repeated fields or map fields.
Protobuf type google.api.HttpRule

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • clear

      public HttpRule.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • getDefaultInstanceForType

      public HttpRule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public HttpRule build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public HttpRule buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public HttpRule.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • setField

      public HttpRule.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • clearField

      public HttpRule.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • clearOneof

      public HttpRule.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • setRepeatedField

      public HttpRule.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • addRepeatedField

      public HttpRule.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • mergeFrom

      public HttpRule.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>

    • mergeFrom

      public HttpRule.Builder mergeFrom(HttpRule other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • mergeFrom

      public HttpRule.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<HttpRule.Builder>
      Throws:
      IOException

    • getPatternCase

      public HttpRule.PatternCase getPatternCase()
      Specified by:
      getPatternCase in interface HttpRuleOrBuilder

    • clearPattern

      public HttpRule.Builder clearPattern()

    • getSelector

      public String getSelector()
       Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
      string selector = 1;
      Specified by:
      getSelector in interface HttpRuleOrBuilder
      Returns:
      The selector.

    • getSelectorBytes

      public com.google.protobuf.ByteString getSelectorBytes()
       Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
      string selector = 1;
      Specified by:
      getSelectorBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for selector.

    • setSelector

      public HttpRule.Builder setSelector(String value)
       Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
      string selector = 1;
      Parameters:
      value - The selector to set.
      Returns:
      This builder for chaining.

    • clearSelector

      public HttpRule.Builder clearSelector()
       Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
      string selector = 1;
      Returns:
      This builder for chaining.

    • setSelectorBytes

      public HttpRule.Builder setSelectorBytes(com.google.protobuf.ByteString value)
       Selects methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
      string selector = 1;
      Parameters:
      value - The bytes for selector to set.
      Returns:
      This builder for chaining.

    • getGet

      public String getGet()
       Used for listing and getting information about resources.
      string get = 2;
      Specified by:
      getGet in interface HttpRuleOrBuilder
      Returns:
      The get.

    • getGetBytes

      public com.google.protobuf.ByteString getGetBytes()
       Used for listing and getting information about resources.
      string get = 2;
      Specified by:
      getGetBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for get.

    • setGet

      public HttpRule.Builder setGet(String value)
       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()
       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)
       Used for listing and getting information about resources.
      string get = 2;
      Parameters:
      value - The bytes for get to set.
      Returns:
      This builder for chaining.

    • getPut

      public String getPut()
       Used for updating a resource.
      string put = 3;
      Specified by:
      getPut in interface HttpRuleOrBuilder
      Returns:
      The put.

    • getPutBytes

      public com.google.protobuf.ByteString getPutBytes()
       Used for updating a resource.
      string put = 3;
      Specified by:
      getPutBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for put.

    • setPut

      public HttpRule.Builder setPut(String value)
       Used for updating a resource.
      string put = 3;
      Parameters:
      value - The put to set.
      Returns:
      This builder for chaining.

    • clearPut

      public HttpRule.Builder clearPut()
       Used for updating a resource.
      string put = 3;
      Returns:
      This builder for chaining.

    • setPutBytes

      public HttpRule.Builder setPutBytes(com.google.protobuf.ByteString value)
       Used for updating a resource.
      string put = 3;
      Parameters:
      value - The bytes for put to set.
      Returns:
      This builder for chaining.

    • getPost

      public String getPost()
       Used for creating a resource.
      string post = 4;
      Specified by:
      getPost in interface HttpRuleOrBuilder
      Returns:
      The post.

    • getPostBytes

      public com.google.protobuf.ByteString getPostBytes()
       Used for creating a resource.
      string post = 4;
      Specified by:
      getPostBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for post.

    • setPost

      public HttpRule.Builder setPost(String value)
       Used for creating a resource.
      string post = 4;
      Parameters:
      value - The post to set.
      Returns:
      This builder for chaining.

    • clearPost

      public HttpRule.Builder clearPost()
       Used for creating a resource.
      string post = 4;
      Returns:
      This builder for chaining.

    • setPostBytes

      public HttpRule.Builder setPostBytes(com.google.protobuf.ByteString value)
       Used for creating a resource.
      string post = 4;
      Parameters:
      value - The bytes for post to set.
      Returns:
      This builder for chaining.

    • getDelete

      public String getDelete()
       Used for deleting a resource.
      string delete = 5;
      Specified by:
      getDelete in interface HttpRuleOrBuilder
      Returns:
      The delete.

    • getDeleteBytes

      public com.google.protobuf.ByteString getDeleteBytes()
       Used for deleting a resource.
      string delete = 5;
      Specified by:
      getDeleteBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for delete.

    • setDelete

      public HttpRule.Builder setDelete(String value)
       Used for deleting a resource.
      string delete = 5;
      Parameters:
      value - The delete to set.
      Returns:
      This builder for chaining.

    • clearDelete

      public HttpRule.Builder clearDelete()
       Used for deleting a resource.
      string delete = 5;
      Returns:
      This builder for chaining.

    • setDeleteBytes

      public HttpRule.Builder setDeleteBytes(com.google.protobuf.ByteString value)
       Used for deleting a resource.
      string delete = 5;
      Parameters:
      value - The bytes for delete to set.
      Returns:
      This builder for chaining.

    • getPatch

      public String getPatch()
       Used for updating a resource.
      string patch = 6;
      Specified by:
      getPatch in interface HttpRuleOrBuilder
      Returns:
      The patch.

    • getPatchBytes

      public com.google.protobuf.ByteString getPatchBytes()
       Used for updating a resource.
      string patch = 6;
      Specified by:
      getPatchBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for patch.

    • setPatch

      public HttpRule.Builder setPatch(String value)
       Used for updating a resource.
      string patch = 6;
      Parameters:
      value - The patch to set.
      Returns:
      This builder for chaining.

    • clearPatch

      public HttpRule.Builder clearPatch()
       Used for updating a resource.
      string patch = 6;
      Returns:
      This builder for chaining.

    • setPatchBytes

      public HttpRule.Builder setPatchBytes(com.google.protobuf.ByteString value)
       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 interface HttpRuleOrBuilder
      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 interface HttpRuleOrBuilder
      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 interface HttpRuleOrBuilder

    • getBody

      public String getBody()
       The name of the request field whose value is mapped to the HTTP body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
      string body = 7;
      Specified by:
      getBody in interface HttpRuleOrBuilder
      Returns:
      The body.

    • getBodyBytes

      public com.google.protobuf.ByteString getBodyBytes()
       The name of the request field whose value is mapped to the HTTP body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
      string body = 7;
      Specified by:
      getBodyBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for body.

    • setBody

      public HttpRule.Builder setBody(String value)
       The name of the request field whose value is mapped to the HTTP body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
      string body = 7;
      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 body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
      string body = 7;
      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 body, or
 `*` for mapping all fields not captured by the path pattern to the HTTP
 body. NOTE: the referred field must not be a repeated field and must be
 present at the top-level of request message type.
      string body = 7;
      Parameters:
      value - The bytes for body to set.
      Returns:
      This builder for chaining.

    • getResponseBody

      public String getResponseBody()
       Optional. The name of the response field whose value is mapped to the HTTP
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.
      string response_body = 12;
      Specified by:
      getResponseBody in interface HttpRuleOrBuilder
      Returns:
      The responseBody.

    • getResponseBodyBytes

      public com.google.protobuf.ByteString getResponseBodyBytes()
       Optional. The name of the response field whose value is mapped to the HTTP
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.
      string response_body = 12;
      Specified by:
      getResponseBodyBytes in interface HttpRuleOrBuilder
      Returns:
      The bytes for responseBody.

    • setResponseBody

      public HttpRule.Builder setResponseBody(String value)
       Optional. The name of the response field whose value is mapped to the HTTP
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.
      string response_body = 12;
      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
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.
      string response_body = 12;
      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
 body of response. Other response fields are ignored. When
 not set, the response message will be used as HTTP body of response.
      string response_body = 12;
      Parameters:
      value - The bytes for responseBody to set.
      Returns:
      This builder for chaining.

    • getAdditionalBindingsList

      public List<HttpRule> getAdditionalBindingsList()
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;
      Specified by:
      getAdditionalBindingsList in interface HttpRuleOrBuilder

    • getAdditionalBindingsCount

      public int getAdditionalBindingsCount()
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;
      Specified by:
      getAdditionalBindingsCount in interface HttpRuleOrBuilder

    • getAdditionalBindings

      public HttpRule getAdditionalBindings(int index)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;
      Specified by:
      getAdditionalBindings in interface HttpRuleOrBuilder

    • setAdditionalBindings

      public HttpRule.Builder setAdditionalBindings(int index, HttpRule value)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • setAdditionalBindings

      public HttpRule.Builder setAdditionalBindings(int index, HttpRule.Builder builderForValue)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • addAdditionalBindings

      public HttpRule.Builder addAdditionalBindings(HttpRule value)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • addAdditionalBindings

      public HttpRule.Builder addAdditionalBindings(int index, HttpRule value)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • addAdditionalBindings

      public HttpRule.Builder addAdditionalBindings(HttpRule.Builder builderForValue)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • addAdditionalBindings

      public HttpRule.Builder addAdditionalBindings(int index, HttpRule.Builder builderForValue)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • addAllAdditionalBindings

      public HttpRule.Builder addAllAdditionalBindings(Iterable<? extends HttpRule> values)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • clearAdditionalBindings

      public HttpRule.Builder clearAdditionalBindings()
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • removeAdditionalBindings

      public HttpRule.Builder removeAdditionalBindings(int index)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • getAdditionalBindingsBuilder

      public HttpRule.Builder getAdditionalBindingsBuilder(int index)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • getAdditionalBindingsOrBuilder

      public HttpRuleOrBuilder getAdditionalBindingsOrBuilder(int index)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;
      Specified by:
      getAdditionalBindingsOrBuilder in interface HttpRuleOrBuilder

    • getAdditionalBindingsOrBuilderList

      public List<? extends HttpRuleOrBuilder> getAdditionalBindingsOrBuilderList()
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;
      Specified by:
      getAdditionalBindingsOrBuilderList in interface HttpRuleOrBuilder

    • addAdditionalBindingsBuilder

      public HttpRule.Builder addAdditionalBindingsBuilder()
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • addAdditionalBindingsBuilder

      public HttpRule.Builder addAdditionalBindingsBuilder(int index)
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • getAdditionalBindingsBuilderList

      public List<HttpRule.Builder> getAdditionalBindingsBuilderList()
       Additional HTTP bindings for the selector. Nested bindings must
 not contain an `additional_bindings` field themselves (that is,
 the nesting may only be one level deep).
      repeated .google.api.HttpRule additional_bindings = 11;

    • setUnknownFields

      public final HttpRule.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>

    • mergeUnknownFields

      public final HttpRule.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<HttpRule.Builder>