Class SystemParameters (2.48.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

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

getDefaultInstanceForType()

public SystemParameters getDefaultInstanceForType()
Returns
Type Description
SystemParameters

getParserForType()

public Parser<SystemParameters> getParserForType()
Returns
Type Description
Parser<SystemParameters>
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
Name Description
index int
Returns
Type Description
SystemParameterRule

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SystemParameters.Builder toBuilder()
Returns
Type Description
SystemParameters.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException