Class SystemParameters.Builder (2.36.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllRules(Iterable<? extends SystemParameterRule> values)

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;

Parameter
NameDescription
valuesIterable<? extends com.google.api.SystemParameterRule>
Returns
TypeDescription
SystemParameters.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SystemParameters.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SystemParameters.Builder
Overrides

addRules(SystemParameterRule value)

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;

Parameter
NameDescription
valueSystemParameterRule
Returns
TypeDescription
SystemParameters.Builder

addRules(SystemParameterRule.Builder builderForValue)

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;

Parameter
NameDescription
builderForValueSystemParameterRule.Builder
Returns
TypeDescription
SystemParameters.Builder

addRules(int index, SystemParameterRule value)

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;

Parameters
NameDescription
indexint
valueSystemParameterRule
Returns
TypeDescription
SystemParameters.Builder

addRules(int index, SystemParameterRule.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueSystemParameterRule.Builder
Returns
TypeDescription
SystemParameters.Builder

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;

Returns
TypeDescription
SystemParameterRule.Builder

addRulesBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
SystemParameterRule.Builder

build()

public SystemParameters build()
Returns
TypeDescription
SystemParameters

buildPartial()

public SystemParameters buildPartial()
Returns
TypeDescription
SystemParameters

clear()

public SystemParameters.Builder clear()
Returns
TypeDescription
SystemParameters.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SystemParameters.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SystemParameters.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SystemParameters.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SystemParameters.Builder
Overrides

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;

Returns
TypeDescription
SystemParameters.Builder

clone()

public SystemParameters.Builder clone()
Returns
TypeDescription
SystemParameters.Builder
Overrides

getDefaultInstanceForType()

public SystemParameters getDefaultInstanceForType()
Returns
TypeDescription
SystemParameters

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getRules(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
SystemParameterRule

getRulesBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
SystemParameterRule.Builder

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;

Returns
TypeDescription
List<Builder>

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;

Returns
TypeDescription
int

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;

Returns
TypeDescription
List<SystemParameterRule>

getRulesOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
SystemParameterRuleOrBuilder

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;

Returns
TypeDescription
List<? extends com.google.api.SystemParameterRuleOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SystemParameters other)

public SystemParameters.Builder mergeFrom(SystemParameters other)
Parameter
NameDescription
otherSystemParameters
Returns
TypeDescription
SystemParameters.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SystemParameters.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SystemParameters.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SystemParameters.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SystemParameters.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SystemParameters.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SystemParameters.Builder
Overrides

removeRules(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
SystemParameters.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SystemParameters.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SystemParameters.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SystemParameters.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SystemParameters.Builder
Overrides

setRules(int index, SystemParameterRule value)

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;

Parameters
NameDescription
indexint
valueSystemParameterRule
Returns
TypeDescription
SystemParameters.Builder

setRules(int index, SystemParameterRule.Builder builderForValue)

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;

Parameters
NameDescription
indexint
builderForValueSystemParameterRule.Builder
Returns
TypeDescription
SystemParameters.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SystemParameters.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SystemParameters.Builder
Overrides