config

API Reference: v1/config.proto

Table of Contents

Services

ConfigurationManagementService

ConfigurationManagementService handles global configuration settings

GetConfiguration

rpc GetConfiguration(GetConfigurationRequest) GetConfigurationResponse

UpsertConfiguration

rpc UpsertConfiguration(UpsertConfigurationRequest) UpsertConfigurationResponse

Messages

GetConfigurationRequest

GetConfigurationRequest is an empty request for getting configuration

GetConfigurationResponse

GetConfigurationResponse contains all global configuration settings

Field Type Description
status Status Operation Status
settings map GetConfigurationResponse.SettingsEntry Map of global configuration settings

GetConfigurationResponse.SettingsEntry

Field Type Description
key string none
value string none

UpsertConfigurationRequest

UpsertConfigurationRequest contains configuration settings to update

Field Type Description
settings map UpsertConfigurationRequest.SettingsEntry global settings to update

UpsertConfigurationRequest.SettingsEntry

Field Type Description
key string none
value string none

UpsertConfigurationResponse

UpsertConfigurationResponse contains the result of configuration update

Field Type Description
status Status Operation Status
updated_settings map UpsertConfigurationResponse.UpdatedSettingsEntry Updated settings

UpsertConfigurationResponse.UpdatedSettingsEntry

Field Type Description
key string none
value string none

Scalar Value Types

.proto Type Notes C++ Type Java Type Python Type

double
double double float

float
float float float

int32
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int

int64
Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long

uint32
Uses variable-length encoding. uint32 int int/long

uint64
Uses variable-length encoding. uint64 long int/long

sint32
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int

sint64
Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long

fixed32
Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int

fixed64
Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long

sfixed32
Always four bytes. int32 int int

sfixed64
Always eight bytes. int64 long int/long

bool
bool boolean boolean

string
A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode

bytes
May contain any arbitrary sequence of bytes. string ByteString str