Interface SystemParametersOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SystemParameters, SystemParameters.Builder

    public interface SystemParametersOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Detail

      • getRulesList

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

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

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

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

        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;