Package com.google.api

Class Http.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite.Builder<Http,Http.Builder>
com.google.api.Http.Builder
All Implemented Interfaces:
HttpOrBuilder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, Cloneable
Enclosing class:
Http
public static final class Http.Builder extends com.google.protobuf.GeneratedMessageLite.Builder<Http,Http.Builder> implements HttpOrBuilder
 Defines the HTTP configuration for an API service. It contains a list of
 [HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method
 to one or more HTTP REST API methods.
Protobuf type google.api.Http

  • Field Summary

    Fields inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    instance

  • Method Summary

    Modifier and Type
    Method
    Description
    Http.Builder
    addAllRules(Iterable<? extends HttpRule> values)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    addRules(int index, HttpRule value)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    addRules(int index, HttpRule.Builder builderForValue)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    addRules(HttpRule value)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    addRules(HttpRule.Builder builderForValue)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    clearFullyDecodeReservedExpansion()
    When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.
    Http.Builder
    clearRules()
    A list of HTTP configuration rules that apply to individual API methods.
    boolean
    getFullyDecodeReservedExpansion()
    When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.
    HttpRule
    getRules(int index)
    A list of HTTP configuration rules that apply to individual API methods.
    int
    getRulesCount()
    A list of HTTP configuration rules that apply to individual API methods.
    List<HttpRule>
    getRulesList()
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    removeRules(int index)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    setFullyDecodeReservedExpansion(boolean value)
    When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.
    Http.Builder
    setRules(int index, HttpRule value)
    A list of HTTP configuration rules that apply to individual API methods.
    Http.Builder
    setRules(int index, HttpRule.Builder builderForValue)
    A list of HTTP configuration rules that apply to individual API methods.

    Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder

    build, buildPartial, clear, clone, copyOnWrite, copyOnWriteInternal, getDefaultInstanceForType, internalMergeFrom, isInitialized, mergeFrom, mergeFrom, mergeFrom, mergeFrom

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getRulesList

      public List<HttpRule> getRulesList()
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];
      Specified by:
      getRulesList in interface HttpOrBuilder

    • getRulesCount

      public int getRulesCount()
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];
      Specified by:
      getRulesCount in interface HttpOrBuilder

    • getRules

      public HttpRule getRules(int index)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];
      Specified by:
      getRules in interface HttpOrBuilder

    • setRules

      public Http.Builder setRules(int index, HttpRule value)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • setRules

      public Http.Builder setRules(int index, HttpRule.Builder builderForValue)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • addRules

      public Http.Builder addRules(HttpRule value)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • addRules

      public Http.Builder addRules(int index, HttpRule value)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • addRules

      public Http.Builder addRules(HttpRule.Builder builderForValue)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • addRules

      public Http.Builder addRules(int index, HttpRule.Builder builderForValue)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • addAllRules

      public Http.Builder addAllRules(Iterable<? extends HttpRule> values)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • clearRules

      public Http.Builder clearRules()
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • removeRules

      public Http.Builder removeRules(int index)
       A list of HTTP configuration rules that apply to individual API methods.

 **NOTE:** All service configuration rules follow "last one wins" order.
      repeated .google.api.HttpRule rules = 1 [json_name = "rules"];

    • getFullyDecodeReservedExpansion

      public boolean getFullyDecodeReservedExpansion()
       When set to true, URL path parameters will be fully URI-decoded except in
 cases of single segment matches in reserved expansion, where "%2F" will be
 left encoded.

 The default behavior is to not decode RFC 6570 reserved characters in multi
 segment matches.
      bool fully_decode_reserved_expansion = 2 [json_name = "fullyDecodeReservedExpansion"];
      Specified by:
      getFullyDecodeReservedExpansion in interface HttpOrBuilder
      Returns:
      The fullyDecodeReservedExpansion.

    • setFullyDecodeReservedExpansion

      public Http.Builder setFullyDecodeReservedExpansion(boolean value)
       When set to true, URL path parameters will be fully URI-decoded except in
 cases of single segment matches in reserved expansion, where "%2F" will be
 left encoded.

 The default behavior is to not decode RFC 6570 reserved characters in multi
 segment matches.
      bool fully_decode_reserved_expansion = 2 [json_name = "fullyDecodeReservedExpansion"];
      Parameters:
      value - The fullyDecodeReservedExpansion to set.
      Returns:
      This builder for chaining.

    • clearFullyDecodeReservedExpansion

      public Http.Builder clearFullyDecodeReservedExpansion()
       When set to true, URL path parameters will be fully URI-decoded except in
 cases of single segment matches in reserved expansion, where "%2F" will be
 left encoded.

 The default behavior is to not decode RFC 6570 reserved characters in multi
 segment matches.
      bool fully_decode_reserved_expansion = 2 [json_name = "fullyDecodeReservedExpansion"];
      Returns:
      This builder for chaining.