Protocol Documentation

Table of Contents

common/common.proto

Top

ClientCredentials

FieldTypeLabelDescription
client_id string

client_secret string

token_url string

scopes string repeated

endpoint_params ClientCredentials.EndpointParamsEntry repeated

ClientCredentials.EndpointParamsEntry

FieldTypeLabelDescription
key string

value string

Common

FieldTypeLabelDescription
identifier string

object google.protobuf.Any

meta Common.MetaEntry repeated

Common.MetaEntry

FieldTypeLabelDescription
key string

value string

DefaultGCPCredentials

FieldTypeLabelDescription
scopes string repeated

HTTPTask

FieldTypeLabelDescription
url string

method string

headers HTTPTask.HeadersEntry repeated

form HTTPTask.FormEntry repeated

username string

password string

body google.protobuf.Any

callback_url string

HTTPTask.FormEntry

FieldTypeLabelDescription
key string

value string

HTTPTask.HeadersEntry

FieldTypeLabelDescription
key string

value string

JSONWebKeys

FieldTypeLabelDescription
kty string

kid string

use string

n string

e string

x5c string repeated

JWT

FieldTypeLabelDescription
email string

private_key bytes

prive_key_id string

subject string

scopes string repeated

token_url string

expires google.protobuf.Timestamp

audience string

Jwks

FieldTypeLabelDescription
keys JSONWebKeys repeated

OAuth2

FieldTypeLabelDescription
client_id string

client_secret string

token_url string

auth_url string

scopes string repeated

redirect string

code string

PlainText

FieldTypeLabelDescription
text string

Scalar Value Types

.proto TypeNotesC++ TypeJava TypePython 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