Package com.google.api

Class SystemParameters.Builder

  • All Implemented Interfaces:
    SystemParametersOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    SystemParameters
    public static final class SystemParameters.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SystemParameters.Builder>
implements SystemParametersOrBuilder
     ### System parameter configuration
 A system parameter is a special kind of parameter defined by the API
 system, not by an individual API. It is typically mapped to an HTTP header
 and/or a URL query parameter. This configuration specifies which methods
 change the names of the system parameters.
    Protobuf type google.api.SystemParameters

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

        public SystemParameters.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<SystemParameters.Builder>
        Throws:
        IOException

      • getRulesList

        public List<SystemParameterRule> getRulesList()
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;
        Specified by:
        getRulesList in interface SystemParametersOrBuilder

      • getRulesCount

        public int getRulesCount()
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;
        Specified by:
        getRulesCount in interface SystemParametersOrBuilder

      • getRules

        public SystemParameterRule getRules​(int index)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;
        Specified by:
        getRules in interface SystemParametersOrBuilder

      • setRules

        public SystemParameters.Builder setRules​(int index,
                                         SystemParameterRule value)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • setRules

        public SystemParameters.Builder setRules​(int index,
                                         SystemParameterRule.Builder builderForValue)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • addRules

        public SystemParameters.Builder addRules​(SystemParameterRule value)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • addRules

        public SystemParameters.Builder addRules​(int index,
                                         SystemParameterRule value)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • addRules

        public SystemParameters.Builder addRules​(SystemParameterRule.Builder builderForValue)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • addRules

        public SystemParameters.Builder addRules​(int index,
                                         SystemParameterRule.Builder builderForValue)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • addAllRules

        public SystemParameters.Builder addAllRules​(Iterable<? extends SystemParameterRule> values)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • clearRules

        public SystemParameters.Builder clearRules()
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • removeRules

        public SystemParameters.Builder removeRules​(int index)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • getRulesBuilder

        public SystemParameterRule.Builder getRulesBuilder​(int index)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • getRulesOrBuilder

        public SystemParameterRuleOrBuilder getRulesOrBuilder​(int index)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;
        Specified by:
        getRulesOrBuilder in interface SystemParametersOrBuilder

      • getRulesOrBuilderList

        public List<? extends SystemParameterRuleOrBuilder> getRulesOrBuilderList()
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;
        Specified by:
        getRulesOrBuilderList in interface SystemParametersOrBuilder

      • addRulesBuilder

        public SystemParameterRule.Builder addRulesBuilder()
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • addRulesBuilder

        public SystemParameterRule.Builder addRulesBuilder​(int index)
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • getRulesBuilderList

        public List<SystemParameterRule.Builder> getRulesBuilderList()
         Define system parameters.
 The parameters defined here will override the default parameters
 implemented by the system. If this field is missing from the service
 config, default system parameters will be used. Default system parameters
 and names is implementation-dependent.
 Example: define api key for all methods
     system_parameters
       rules:
         - selector: "*"
           parameters:
             - name: api_key
               url_query_parameter: api_key
 Example: define 2 api key names for a specific method.
     system_parameters
       rules:
         - selector: "/ListShelves"
           parameters:
             - name: api_key
               http_header: Api-Key1
             - name: api_key
               http_header: Api-Key2
 **NOTE:** All service configuration rules follow "last one wins" order.
        repeated .google.api.SystemParameterRule rules = 1;

      • setUnknownFields

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

      • mergeUnknownFields

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