Class SystemParameters (2.36.0)

public final class SystemParameters extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SystemParameters

Implements

SystemParametersOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

RULES_FIELD_NUMBER

public static final int RULES_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static SystemParameters getDefaultInstance()

Returns
Type	Description
`SystemParameters`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static SystemParameters.Builder newBuilder()

Returns
Type	Description
`SystemParameters.Builder`

newBuilder(SystemParameters prototype)

public static SystemParameters.Builder newBuilder(SystemParameters prototype)

Parameter
Name	Description
`prototype`	`SystemParameters`

Returns
Type	Description
`SystemParameters.Builder`

parseDelimitedFrom(InputStream input)

public static SystemParameters parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SystemParameters parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static SystemParameters parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SystemParameters parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static SystemParameters parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SystemParameters parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static SystemParameters parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SystemParameters parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static SystemParameters parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SystemParameters parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static SystemParameters parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SystemParameters parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`SystemParameters`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<SystemParameters> parser()

Returns
Type	Description
`Parser<SystemParameters>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SystemParameters getDefaultInstanceForType()

Returns
Type	Description
`SystemParameters`

getParserForType()

public Parser<SystemParameters> getParserForType()

Returns
Type	Description
`Parser<SystemParameters>`

Overrides

GeneratedMessageV3.getParserForType()

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`

getRulesCount()

public int getRulesCount()

Define system parameters.

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.

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.

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.

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>`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public SystemParameters.Builder newBuilderForType()

Returns
Type	Description
`SystemParameters.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SystemParameters.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`SystemParameters.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public SystemParameters.Builder toBuilder()

Returns
Type	Description
`SystemParameters.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`