Class SystemParameters.Builder (2.7.4)

Version 2.7.4

• 2.49.0 (latest)
• 2.48.0
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SystemParameters.Builder

Implements

SystemParametersOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
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

Name	Description
values	Iterable<? extends com.google.api.SystemParameterRule>

Returns

Type	Description
SystemParameters.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SystemParameters.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Name	Description
value	SystemParameterRule

Returns

Type	Description
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

Name	Description
builderForValue	SystemParameterRule.Builder

Returns

Type	Description
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

Name	Description
index	int
value	SystemParameterRule

Returns

Type	Description
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

Name	Description
index	int
builderForValue	SystemParameterRule.Builder

Returns

Type	Description
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

Type	Description
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

Name	Description
index	int

Returns

Type	Description
SystemParameterRule.Builder

build()

public SystemParameters build()

Returns

Type	Description
SystemParameters

buildPartial()

public SystemParameters buildPartial()

Returns

Type	Description
SystemParameters

clear()

public SystemParameters.Builder clear()

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SystemParameters.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SystemParameters.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Type	Description
SystemParameters.Builder

clone()

public SystemParameters.Builder clone()

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SystemParameters getDefaultInstanceForType()

Returns

Type	Description
SystemParameters

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Name	Description
index	int

Returns

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

Type	Description
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

Type	Description
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

Type	Description
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

Name	Description
index	int

Returns

Type	Description
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

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SystemParameters other)

public SystemParameters.Builder mergeFrom(SystemParameters other)

Parameter

Name	Description
other	SystemParameters

Returns

Type	Description
SystemParameters.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SystemParameters.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
SystemParameters.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public SystemParameters.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
SystemParameters.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SystemParameters.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Name	Description
index	int

Returns

Type	Description
SystemParameters.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public SystemParameters.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

Name	Description
index	int
value	SystemParameterRule

Returns

Type	Description
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

Name	Description
index	int
builderForValue	SystemParameterRule.Builder

Returns

Type	Description
SystemParameters.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final SystemParameters.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
SystemParameters.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)