Skip to main content

Package: directory

The ski package is the protobuf designed for common e2ee applications.

E2eeDomainProfile

Profile of an e2ee service domain.

FieldTypeLabelDescription
api_server_grpcServiceConnectionThe grpc api server host:port.
api_server_httpServiceConnectionThe http api server host:port.
file_server_grpcServiceConnectionThe reserved grpc file server host:port.
file_server_httpServiceConnectionThe http file server host:port.
backup_server_grpcServiceConnectionThe optional grpc backup server host:port.
backup_server_httpServiceConnectionThe optional http backup server host:port.
streaming_serverServiceConnectionThe optional streaming server url.

ServiceConnection

FieldTypeLabelDescription
apistringThe api style (ex: restful, grpc, ws).
hoststringThe host.
portint32The port.

Top

directory/LookupDomainProfileRequest.proto

LookupDomainProfileRequest

Request for looking up an e2ee service profile.

FieldTypeLabelDescription
domainstringThe domain for retriving the profile.

Top

directory/LookupDomainProfileResponse.proto

LookupDomainProfileResponse

Response for looking up an e2ee service profile.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
profileE2eeDomainProfileThe returned e2ee service profile.

Top

directory/RetrieveCertListRequest.proto

RetrieveCertListRequest

Request for retriving list of certificates by giving time stamp.

FieldTypeLabelDescription
tsint64The timestamp for retriving the certificates that is updated later.

Top

directory/RetrieveCertListResponse.proto

RetrieveCertListResponse

Response for retrieving list of certificates.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
certificate_liste2ees.CertificaterepeatedThe returned list of certificates.

Top

directory/RetrieveCertRequest.proto

RetrieveCertRequest

Request for retriving a certificate by domain.

FieldTypeLabelDescription
domainstringThe domain for retriving the profile.

Top

directory/RetrieveCertResponse.proto

RetrieveCertResponse

Response for retrieving a certificate.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.
certificatee2ees.CertificateThe returned certificate.

Top

directory/ValidateCertRequest.proto

ValidateCertRequest

Request for validating a certificate by domain.

FieldTypeLabelDescription
domainstringThe domain for retriving the profile.
cert_fingerprintbytesThe hash value as the fingerprint of cert that is being validated.

Top

directory/ValidateCertResponse.proto

ValidateCertResponse

Response for validating a certificate.

FieldTypeLabelDescription
codee2ees.ResponseCodeThe response code.
msgstringOptional response message.

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)