Interface SystemParametersOrBuilder (2.43.0) 

public interface SystemParametersOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getRules(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
SystemParameterRule

getRulesCount()

public abstract 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;

Returns
Type Description
int

getRulesList()

public abstract 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;

Returns
Type Description
List<SystemParameterRule>

getRulesOrBuilder(int index)

public abstract 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;

Parameter
Name Description
index int
Returns
Type Description
SystemParameterRuleOrBuilder

getRulesOrBuilderList()

public abstract 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;

Returns
Type Description
List<? extends com.google.api.SystemParameterRuleOrBuilder>