Package com.google.api

Class Http.Builder

  • All Implemented Interfaces:
    HttpOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    Http
    public static final class Http.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Http.Builder>
implements HttpOrBuilder
     Defines the HTTP configuration for a 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Http.Builder addAllRules​(java.lang.Iterable<? extends HttpRule> values)
      A list of HTTP configuration rules that apply to individual API methods.
      Http.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      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.
      HttpRule.Builder addRulesBuilder()
      A list of HTTP configuration rules that apply to individual API methods.
      HttpRule.Builder addRulesBuilder​(int index)
      A list of HTTP configuration rules that apply to individual API methods.
      Http build()  
      Http buildPartial()  
      Http.Builder clear()  
      Http.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      Http.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      Http.Builder clearRules()
      A list of HTTP configuration rules that apply to individual API methods.
      Http.Builder clone()  
      Http getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      HttpRule getRules​(int index)
      A list of HTTP configuration rules that apply to individual API methods.
      HttpRule.Builder getRulesBuilder​(int index)
      A list of HTTP configuration rules that apply to individual API methods.
      java.util.List<HttpRule.Builder> getRulesBuilderList()
      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.
      java.util.List<HttpRule> getRulesList()
      A list of HTTP configuration rules that apply to individual API methods.
      HttpRuleOrBuilder getRulesOrBuilder​(int index)
      A list of HTTP configuration rules that apply to individual API methods.
      java.util.List<? extends HttpRuleOrBuilder> getRulesOrBuilderList()
      A list of HTTP configuration rules that apply to individual API methods.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      Http.Builder mergeFrom​(Http other)  
      Http.Builder mergeFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      Http.Builder mergeFrom​(com.google.protobuf.Message other)  
      Http.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      Http.Builder removeRules​(int index)
      A list of HTTP configuration rules that apply to individual API methods.
      Http.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      Http.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      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.
      Http.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

        getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

      • Methods inherited from class com.google.protobuf.AbstractMessage.Builder

        findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

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

        addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface com.google.protobuf.Message.Builder

        mergeDelimitedFrom, mergeDelimitedFrom

      • Methods inherited from interface com.google.protobuf.MessageLite.Builder

        mergeFrom

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • 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<Http.Builder>

      • clear

        public Http.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<Http.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<Http.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Http.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<Http.Builder>

      • setField

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

      • clearField

        public Http.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<Http.Builder>

      • clearOneof

        public Http.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<Http.Builder>

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

        public Http.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<Http.Builder>

      • isInitialized

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

      • mergeFrom

        public Http.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.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<Http.Builder>
        Throws:
        java.io.IOException

      • getRulesList

        public java.util.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;
        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;
        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;
        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;

      • 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;

      • 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;

      • 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;

      • 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;

      • 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;

      • addAllRules

        public Http.Builder addAllRules​(java.lang.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;

      • 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;

      • 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;

      • getRulesBuilder

        public HttpRule.Builder getRulesBuilder​(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;

      • getRulesOrBuilder

        public HttpRuleOrBuilder getRulesOrBuilder​(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;
        Specified by:
        getRulesOrBuilder in interface HttpOrBuilder

      • getRulesOrBuilderList

        public java.util.List<? extends HttpRuleOrBuilder> getRulesOrBuilderList()
         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;
        Specified by:
        getRulesOrBuilderList in interface HttpOrBuilder

      • addRulesBuilder

        public HttpRule.Builder addRulesBuilder()
         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;

      • addRulesBuilder

        public HttpRule.Builder addRulesBuilder​(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;

      • getRulesBuilderList

        public java.util.List<HttpRule.Builder> getRulesBuilderList()
         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;

      • setUnknownFields

        public final Http.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<Http.Builder>

      • mergeUnknownFields

        public final Http.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<Http.Builder>