Protocol Documentation

Table of Contents

deephaven_enterprise/proto/acl.proto

Top

BooleanResponse

FieldTypeLabelDescription
isTrue bool

GetAllGroupsRequest

FieldTypeLabelDescription
cookie bytes

GetAllUsersRequest

FieldTypeLabelDescription
cookie bytes

UnaryGroupRequest

FieldTypeLabelDescription
cookie bytes

group string

UnaryUserRequest

FieldTypeLabelDescription
cookie bytes

user io.deephaven.proto.auth.UserContext

UserOrGroupList

FieldTypeLabelDescription
cookie bytes

usersOrGroups string repeated

deephaven_enterprise/proto/auth.proto

Top

AuthError

Enough information to propagate the basics of an AuthException

from the server to the client by sending this message in

Metadata.

FieldTypeLabelDescription
callStatus CallStatus

message string

AuthenticateByCookieRequest

Request argument for authenticateByCookieRequest rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
client_id ClientId

the new client id for the client making the request.

user_context UserContext

the credentials desired, which should match the cookie.

cookie bytes

a valid cookie for another client on the same user context.

AuthenticateByCookieResponse

Request response for replaceClient rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
result AuthenticationResult

AuthenticateByDelegateTokenRequest

Request argument for authenticateByDelegateToken rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
client_id ClientId

delegate_token Token

AuthenticateByDelegateTokenResponse

Request response for authenticateByDelegateToken rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
result AuthenticationResult

AuthenticateByExternalRequest

Request argument for authenticateByExternal rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
client_id ClientId

the client id for the client making the request.

key string

the key for external authentication.

AuthenticateByExternalResponse

Request response for authenticateByExternal rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
result AuthenticationResult

AuthenticateByPasswordRequest

Request argument for authenticateByPassword prc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
client_id ClientId

the client id for the client making the request.

user_context UserContext

the credentials desired.

password string

the password.

AuthenticateByPasswordResponse

Request response for authenticateByPassword rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
result AuthenticationResult

AuthenticateByPublicKeyRequest

Request argument for authenticateByPublicKey rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
client_id ClientId

the client id for the client making the request.

user_context UserContext

the credentials desired.

public_key bytes

the public key.

challenge_response bytes

The nonce challenge response, which should have been obtained from processing the result of an earlier getNonce rpc request by the client.

ip_address bytes

the ip address of the server that provided the nonce

AuthenticateByPublicKeyResponse

Request response for authenticateByPublicKey rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
result AuthenticationResult

AuthenticationResult

Servers respond to Authenticate* requests with an opaque cookie for the (client_id, user, effectiveUser) combination

granted in the request. clients remember and use the same cookie in subsequent RPCs to the server that intend to use

those credentials. This cookie should be refreshed prior to the deadline, which is represented as milliseconds since

epoch. Clients are encouraged to refresh considerably in advance of the deadline, as to be able to continue

operating under network delays. The expected pattern is for clients to refresh half-way throught their

available period from the last refresh to the deadline.

FieldTypeLabelDescription
authenticated bool

true if authentication was successful.

cookie bytes

the cookie that the client should remember and refresh before its deadline to remain authenticated.

cookie_deadline_time_millis sfixed64

the absolute time in milliseconds from the epoch when the cookie will expire.

userContext UserContext

the user context actually authenticated; if there was one in the request should match it.

ClientId

A unique client identifier sent by clients to introduce themselves to servers.

FieldTypeLabelDescription
name string

uuid bytes

A client uuid in bytes is created by client library code and used for the lifetime of that client process. A client's uuid is expected by the server to be unique across all live client channels. If the same client process during its lifetime connects to different server processes, be it on different machines or different server process instances on the same machine (eg, server bounce), the client process is expected to use the same uuid to all servers.

GetNonceRequest

Request argument for getNonce rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
client_id ClientId

the client id for the client making the request.

GetNonceResponse

Request response for getNonce rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
nonce bytes

the nonce payload

ip_address bytes

the ip address of the server host that produced the nonce

GetTokenAsRequest

Request argument for getTokenAs rpc

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
cookie bytes

the cookie for the client making the request.

service string

the service for which the token is intended.

operateAsUser string

the user as whom the client desires to operate.

GetTokenAsResponse

Request response for getTokenAs rpc

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
token Token

the token payload

GetTokenRequest

Request argument for getToken rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
cookie bytes

the cookie for the client making the request.

service string

the service for which the token is intended.

GetTokenResponse

Request response for getToken rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
token Token

the token payload

InvalidateCookieRequest

Request argument for invalidateCookie rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
cookie bytes

the cookie value to invalidate.

InvalidateCookieResponse

Request response for invalidateCookie rpc.

See the service definition file for details on the rpc request.

KvClientData

This message is not used in requests/responses, but to serialize/deserialize the

information associated with a uuid client (KV key) with its payload (KV value) in etcd.

FieldTypeLabelDescription
hashedCookie bytes

userContext UserContext

RefreshCookieRequest

Request argument for refreshCookie rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
cookie bytes

The actual cookie that was handed to the client by the server, that the client is trying to refresh.

RefreshCookieResponse

Request response for refreshCookie rpc.

See the service definition file for details on the rpc request.

If the RefreshCookieResponse includes a new cookie, then the cookie

has cycled and the previous cookie will timeout.

FieldTypeLabelDescription
cookie bytes

The cookie; clients should note if it has changed from the one they handed to the request.

cookie_deadline_time_millis sfixed64

Absolute time expressed as milliseconds from the epoch when cookie expires.

ReloadRequest

Request argument for reload rpc.

See the service definition file for details on the rpc request.

ReloadResponse

Request response for reload rpc.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
result string

A string that a tool asking for configuration reload can show.

Token

A token is a server-generated identifier for a client that allows the client to present themselves to other

services using the token as a means of verifying identity and credentials; the other service can validate

a token provided by a client with an authentication server to confirm the claimed identity and credentials.

FieldTypeLabelDescription
token_id fixed64

The actual token payload.

service string

The service for which the token is intended.

user_context UserContext

The credentials for the token.

ip_address bytes

The ip address of the authentication server that produced the token.

UserContext

FieldTypeLabelDescription
authenticatedUser string

effectiveUser string

VerifyChallengeRequest

Request argument for verifyNonce request.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
server_ip_address bytes

the ip address of the server making the request on behalf of a client

client_id ClientId

the client id for the client making the originating request

user_context UserContext

the credentials desired.

public_key bytes

the public key.

challenge_response bytes

The nonce challenge response, which should have been obtained from processing the result of an earlier getNonce rpc request by the client on the server receiving this request ("this" server)

VerifyChallengeResponse

Request response for verifyNonce request.

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
success bool

userContext UserContext

The user context that can be actually authenticated; if there was one in the original client request this should match it.

VerifyTokenRequest

Request argument for verifyToken rpc

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
service string

the service who received the token and wishes to verify.

token Token

the token payload for verification.

VerifyTokenResponse

Request response for verifyToken rpc

See the service definition file for details on the rpc request.

FieldTypeLabelDescription
token_valid bool

whether the token is valid or not.

CallStatus

Map directly to classes derived from AuthException.

If you modify this enum, ensure to keep consistent the mappings to/from it

in GrpcAuthenticationService.java and GrpcAuthenticationClientManager.java.

NameNumberDescription
OK 0

No error, everything is fine.
AUTH_ERROR_NON_RETRYABLE 1

AuthException, non-retryable.
AUTH_ERROR_RETRYABLE 2

AuthException, retryable.
ALREADY_AUTHENTICATED 3

AlreadyAuthenticatedException
NOT_AUTHENTICATED 4

NotAuthenticatedException
PUB_PRIV_KEY 5

PubPrivKeyException
TOKEN_CREATION 6

TokenCreationException
TOKEN_VERIFICATION 7

TokenVerificationException
UNAVAILABLE 8

UnavailableException

deephaven_enterprise/proto/auth_service.proto

Top

AuthApi

Method NameRequest TypeResponse TypeDescription
ping .io.deephaven.proto.common.PingRequest .io.deephaven.proto.common.PingResponse

Simple ping method that allows a client to sample the latency to the server.
authenticateByPassword .io.deephaven.proto.auth.AuthenticateByPasswordRequest .io.deephaven.proto.auth.AuthenticateByPasswordResponse

Authenticate by password.
authenticateByPublicKey .io.deephaven.proto.auth.AuthenticateByPublicKeyRequest .io.deephaven.proto.auth.AuthenticateByPublicKeyResponse

Authenticate by public key challenge; should have obtained a nonce earlier via getNonce rpc.
authenticateByDelegateToken .io.deephaven.proto.auth.AuthenticateByDelegateTokenRequest .io.deephaven.proto.auth.AuthenticateByDelegateTokenResponse

Authenticate by delegate token; should have obtained a token earlier from another service that created it and forwarded it.
authenticateByExternal .io.deephaven.proto.auth.AuthenticateByExternalRequest .io.deephaven.proto.auth.AuthenticateByExternalResponse

Authenticate by an external method (eg, active directory).
authenticateByCookie .io.deephaven.proto.auth.AuthenticateByCookieRequest .io.deephaven.proto.auth.AuthenticateByCookieResponse

Authenticate by providing an already existing cookie and the user context that cookie should be associated with.
refreshCookie .io.deephaven.proto.auth.RefreshCookieRequest .io.deephaven.proto.auth.RefreshCookieResponse

Refresh a cookie to maintain credentials. Clients are expected to try to refresh cookies with enough time in advance before expiration; a reasonable default is half way through from the time the cookie was obtained with its deadline, and the actual deadline time.
invalidateCookie .io.deephaven.proto.auth.InvalidateCookieRequest .io.deephaven.proto.auth.InvalidateCookieResponse

Clients that are about to terminate are expected to invalidate their credentials before going away.
getNonce .io.deephaven.proto.auth.GetNonceRequest .io.deephaven.proto.auth.GetNonceResponse

Get a nonce for public key authentication.
getToken .io.deephaven.proto.auth.GetTokenRequest .io.deephaven.proto.auth.GetTokenResponse

Get a token for a three-way handshake.
getTokenAs .io.deephaven.proto.auth.GetTokenAsRequest .io.deephaven.proto.auth.GetTokenAsResponse

Get a token for a three-way handshake as a particular user.
verifyToken .io.deephaven.proto.auth.VerifyTokenRequest .io.deephaven.proto.auth.VerifyTokenResponse

Verify a token provided by another service.
reload .io.deephaven.proto.auth.ReloadRequest .io.deephaven.proto.auth.ReloadResponse

Request this server to reload its configuration.
verifyChallenge .io.deephaven.proto.auth.VerifyChallengeRequest .io.deephaven.proto.auth.VerifyChallengeResponse

Verify a nonce challenge response for another server (not used directly by clients, only server-server)

deephaven_enterprise/proto/common.proto

Top

AboutReply

Response to about request.

FieldTypeLabelDescription
version int32

name string

message string

AboutRequest

Request for About information.

AuthReply

Response to authentication request.

FieldTypeLabelDescription
isAuthenticated bool

AuthRequest

Request to authenticate.

FieldTypeLabelDescription
token bytes

serialized AuthToken, will be empty if the token is null

ExceptionDetailsMessage

FieldTypeLabelDescription
errorMessage string

stackTrace string

shortCauses string

PingRequest

FieldTypeLabelDescription
sender_send_time_millis sfixed64

from string

a log-printable string identifying the sender of the request.

PingResponse

FieldTypeLabelDescription
receiver_receive_time_millis sfixed64

from string

a log-printable string identifying the sender of the response.

NamespaceSetEnum

Enum mirroring NamespaceSet

NameNumberDescription
UNSET 0

SYSTEM 1

USER 2

deephaven_enterprise/proto/config.proto

Top

DeleteFilesRequest

Delete one or more properties files

FieldTypeLabelDescription
name string repeated

DeleteFilesResponse

response to DeleteFilesRequest

just success or an exception

GetAllFilesRequest

GetFileRequest

FieldTypeLabelDescription
name string

GetFileResponse

FieldTypeLabelDescription
name string

contentBytes bytes

UpdateFileRequest

FieldTypeLabelDescription
name string

contentBytes bytes

updateOnSameContents bool

UpdateFileResponse

UpdateFilesRequest

FieldTypeLabelDescription
updateFileRequest UpdateFileRequest repeated

deephaven_enterprise/proto/config_service.proto

Top

ConfigApi

Method NameRequest TypeResponse TypeDescription
about .io.deephaven.proto.common.AboutRequest .io.deephaven.proto.common.AboutReply

getFile .io.deephaven.proto.config.GetFileRequest .io.deephaven.proto.config.GetFileResponse

Get the text of a single file. This is needed to implement PropertInputStreamLoader.
getAllFiles .io.deephaven.proto.config.GetAllFilesRequest .io.deephaven.proto.config.GetFileResponse stream

Get the text of all properties files.
updateFile .io.deephaven.proto.config.UpdateFileRequest .io.deephaven.proto.config.UpdateFileResponse

Attempt to update a properties file.
deleteFiles .io.deephaven.proto.config.DeleteFilesRequest .io.deephaven.proto.config.DeleteFilesResponse

Attempt to delete one or more properties files. Deleting a non-existant file is not considered an error.

deephaven_enterprise/proto/controller.proto

Top

AddQueryRequest

FieldTypeLabelDescription
cookie bytes

config PersistentQueryConfigMessage

AddQueryResponse

FieldTypeLabelDescription
querySerial int64

AssignmentPolicyConfigMessage

FieldTypeLabelDescription
name string

displayName string

description string optional

acceptsParameters bool

AuthenticationRequest

FieldTypeLabelDescription
token io.deephaven.proto.auth.Token

clientId io.deephaven.proto.auth.ClientId

getConfiguration bool

AuthenticationResponse

FieldTypeLabelDescription
authenticated bool

cookie bytes

config ControllerConfigurationMessage optional

ConsoleConfigurationTypeMessage

FieldTypeLabelDescription
name string

displayName string

displayable bool

properties ConsoleConfigurationTypeMessage.PropertiesEntry repeated

hasScript bool

serverClasses string repeated

allowedGroups string repeated

extraColumns ExtraColumnMessage repeated

typeSpecificWireConfigJSON string optional

configCheckerClass string

configPanelFactoryClass string

customActionProviderClass string

setupQueryClass string

configClass string

shutdownProcedureClass string

extraJvmArgsClass string

configProcessorClass string

extraColumnGetterClass string

popupProviderClass string repeated

configTypeDetailsClass string

communityInitializerClass string

hasScriptLanguage bool

communityRequestProcessorClass string

supportsReplicas bool

ConsoleConfigurationTypeMessage.PropertiesEntry

FieldTypeLabelDescription
key string

value string

ControllerConfigurationMessage

FieldTypeLabelDescription
maxHeapSizeGb int32

minDataBufferPoolRatio double

maxDataBufferPoolRatio double

configurationTypes ConsoleConfigurationTypeMessage repeated

temporaryQueueDetails ControllerTempQueueDetailsMessage repeated

defaultTempQueueName string

dbServers PQDBServerConfigMessage repeated

defaultSchedulingDetails string repeated

scheduleLookForwardDays int32

publicKey bytes

algorithm string

consoleServerGroups NamedStringList repeated

jvmProfileNames string repeated

defaultJvmProfileName string

dataRoutingImplName string

tdsConfigs RoutingConfigMessage repeated

disConfigs RoutingConfigMessage repeated

lasConfigs RoutingConfigMessage repeated

assignmentPolicies AssignmentPolicyConfigMessage repeated

defaultAssignmentPolicyName string

defaultAssignmentPolicyParams string

ControllerTempQueueDetailsMessage

FieldTypeLabelDescription
name string

maxConcurrentQueries int32

maxHeapMb int32

DetermineDispatcherRequest

FieldTypeLabelDescription
cookie bytes

serverGroupName string

heapSizeMb int32

workerKind string

DetermineDispatcherResponse

FieldTypeLabelDescription
serverConfig PQDBServerConfigMessage

ExtraColumnMessage

FieldTypeLabelDescription
name string

rendererName string

GetConfigurationRequest

FieldTypeLabelDescription
cookie bytes

GetConfigurationResponse

FieldTypeLabelDescription
config ControllerConfigurationMessage

GetScriptPathsRequest

FieldTypeLabelDescription
cookie bytes

command ScriptCommandEnum

querySerial int64 optional

effectiveUser string optional

scriptLoaderStateJSON string optional

useRelativePath bool

GetScriptPathsResponse

FieldTypeLabelDescription
results string repeated

GetScriptRequest

FieldTypeLabelDescription
cookie bytes

command ScriptCommandEnum

querySerial int64 optional

effectiveUser string optional

scriptLoaderStateJSON string optional

scriptPath string

useRelativePath bool

GetScriptResponse

FieldTypeLabelDescription
scriptBody string optional

ModifyQueryRequest

FieldTypeLabelDescription
cookie bytes

config PersistentQueryConfigMessage

doRestart bool

ModifyQueryResponse

PQDBServerConfigMessage

FieldTypeLabelDescription
name string

host string

port int32

classPushListResourceName string optional

serverClass string

maxHeapSizeGb double

serverType ServerTypeEnum

consoleGroups string repeated

serverInfo string optional

ReloadConfigRequest

FieldTypeLabelDescription
cookie bytes

ReloadConfigResponse

RemoveQueryRequest

FieldTypeLabelDescription
cookie bytes

serial int64

RemoveQueryResponse

ReplicaSpecifier

FieldTypeLabelDescription
serial int64

replica int32

spare int32

processInfoId string optional

ReplicaStatus

FieldTypeLabelDescription
replica ReplicaSpecifier

success bool

error string optional

RestartQueryRequest

FieldTypeLabelDescription
cookie bytes

serials int64 repeated

RestartQueryResponse

FieldTypeLabelDescription
successSerials int64 repeated

errorSerials RestartQueryResponse.ErrorSerialsEntry repeated

RestartQueryResponse.ErrorSerialsEntry

FieldTypeLabelDescription
key int64

value string

RestartReplicaRequest

FieldTypeLabelDescription
cookie bytes

replicas ReplicaSpecifier repeated

RestartReplicaResponse

FieldTypeLabelDescription
status ReplicaStatus repeated

RoutingConfigMessage

FieldTypeLabelDescription
name string

tags string repeated

description string

ServerSelectionAdminRequest

FieldTypeLabelDescription
cookie bytes

command string

ServerSelectionAdminResponse

FieldTypeLabelDescription
result string

ServerSelectionStatusRequest

FieldTypeLabelDescription
cookie bytes

ServerSelectionStatusResponse

FieldTypeLabelDescription
status string

StatusUpdateRequest

FieldTypeLabelDescription
cookie bytes

querySerial int64

status PersistentQueryStatusEnum optional

hasExportedObjects bool

exportedObjects ExportedObjectInfoMessage repeated

hasTableGroups bool

tableGroups NamedStringList repeated

processInfoId string

StatusUpdateResponse

StopQueryRequest

FieldTypeLabelDescription
cookie bytes

serials int64 repeated

StopQueryResponse

FieldTypeLabelDescription
successSerials int64 repeated

errorSerials StopQueryResponse.ErrorSerialsEntry repeated

StopQueryResponse.ErrorSerialsEntry

FieldTypeLabelDescription
key int64

value string

StopReplicaRequest

FieldTypeLabelDescription
cookie bytes

replicas ReplicaSpecifier repeated

StopReplicaResponse

FieldTypeLabelDescription
status ReplicaStatus repeated

SubscribeRequest

FieldTypeLabelDescription
cookie bytes

SubscribeResponse

FieldTypeLabelDescription
event SubscriptionEvent

querySerial int64

Only populated for SE_REMOVE

queryInfo PersistentQueryInfoMessage

Only populated for SE_PUT or SE_BATCH_END

config ControllerConfigurationMessage

Only populated for SE_CONFIG_UPDATE

ScriptCommandEnum

NameNumberDescription
SCE_UNSPECIFIED 0

SCE_GET_AS_SELF 1

SCE_GET_AS_OTHER 2

SCE_GET_FOR_QUERY 3

ServerTypeEnum

NameNumberDescription
STE_UNSPECIFIED 0

STE_DISPATCHER 1

STE_GROUP 2

SubscriptionEvent

NameNumberDescription
SE_UNSPECIFIED 0

SE_PUT 1

SE_REMOVE 2

SE_CONFIG_UPDATE 3

SE_BATCH_END 4

deephaven_enterprise/proto/controller_common.proto

Top

ErrorResponse

FieldTypeLabelDescription
message string

NamedStringList

FieldTypeLabelDescription
name string

values string repeated

PingRequest

FieldTypeLabelDescription
cookie bytes optional

PingResponse

deephaven_enterprise/proto/controller_service.proto

Top

AclApi

Method NameRequest TypeResponse TypeDescription
isSuperUser .io.deephaven.proto.controller.UnaryUserRequest .io.deephaven.proto.controller.BooleanResponse

isAclEditor .io.deephaven.proto.controller.UnaryUserRequest .io.deephaven.proto.controller.BooleanResponse

isQueryManager .io.deephaven.proto.controller.UnaryUserRequest .io.deephaven.proto.controller.BooleanResponse

isSchemaManager .io.deephaven.proto.controller.UnaryUserRequest .io.deephaven.proto.controller.BooleanResponse

getUsersForGroup .io.deephaven.proto.controller.UnaryGroupRequest .io.deephaven.proto.controller.UserOrGroupList

getGroupsForUser .io.deephaven.proto.controller.UnaryUserRequest .io.deephaven.proto.controller.UserOrGroupList

getAllUsers .io.deephaven.proto.controller.GetAllUsersRequest .io.deephaven.proto.controller.UserOrGroupList

getAllGroups .io.deephaven.proto.controller.GetAllGroupsRequest .io.deephaven.proto.controller.UserOrGroupList

ControllerApi

Method NameRequest TypeResponse TypeDescription
authenticate .io.deephaven.proto.controller.AuthenticationRequest .io.deephaven.proto.controller.AuthenticationResponse

Authentication
addQuery .io.deephaven.proto.controller.AddQueryRequest .io.deephaven.proto.controller.AddQueryResponse

These are for query management
removeQuery .io.deephaven.proto.controller.RemoveQueryRequest .io.deephaven.proto.controller.RemoveQueryResponse

modifyQuery .io.deephaven.proto.controller.ModifyQueryRequest .io.deephaven.proto.controller.ModifyQueryResponse

restartQuery .io.deephaven.proto.controller.RestartQueryRequest .io.deephaven.proto.controller.RestartQueryResponse

stopQuery .io.deephaven.proto.controller.StopQueryRequest .io.deephaven.proto.controller.StopQueryResponse

restartReplica .io.deephaven.proto.controller.RestartReplicaRequest .io.deephaven.proto.controller.RestartReplicaResponse

stopReplica .io.deephaven.proto.controller.StopReplicaRequest .io.deephaven.proto.controller.StopReplicaResponse

determineDispatcher .io.deephaven.proto.controller.DetermineDispatcherRequest .io.deephaven.proto.controller.DetermineDispatcherResponse

selectionProviderStatus .io.deephaven.proto.controller.ServerSelectionStatusRequest .io.deephaven.proto.controller.ServerSelectionStatusResponse

selectionProviderAdmin .io.deephaven.proto.controller.ServerSelectionAdminRequest .io.deephaven.proto.controller.ServerSelectionAdminResponse

getConfiguration .io.deephaven.proto.controller.GetConfigurationRequest .io.deephaven.proto.controller.GetConfigurationResponse

getScriptPaths .io.deephaven.proto.controller.GetScriptPathsRequest .io.deephaven.proto.controller.GetScriptPathsResponse

Script commands
getScript .io.deephaven.proto.controller.GetScriptRequest .io.deephaven.proto.controller.GetScriptResponse

statusUpdate .io.deephaven.proto.controller.StatusUpdateRequest .io.deephaven.proto.controller.StatusUpdateResponse

Configuration commands
reloadConfig .io.deephaven.proto.controller.ReloadConfigRequest .io.deephaven.proto.controller.ReloadConfigResponse

ping .io.deephaven.proto.controller.PingRequest .io.deephaven.proto.controller.PingResponse

Heartbeating
subscribe .io.deephaven.proto.controller.SubscribeRequest .io.deephaven.proto.controller.SubscribeResponse stream

invalidateCookie .io.deephaven.proto.auth.InvalidateCookieRequest .io.deephaven.proto.auth.InvalidateCookieResponse

deephaven_enterprise/proto/persistent_query.proto

Top

ExportedObjectInfoMessage

FieldTypeLabelDescription
name string

type ExportedObjectTypeEnum

tableDefinition io.deephaven.proto.common.TableDefinitionMessage

originalType string

PersistentQueryConfigMessage

FieldTypeLabelDescription
serial int64

The serial number is a unique identifier for this persistent query. From the perspective of the controller, the serial number is what determines which query is which.

version int64

The modification version of this persistent query, which increases by one each time the configuration is modified.

name string

The name of this persistent query. Currently, the name must be unique to make diagnosing problems easier.

owner string

The owner of the query. The query runs in the user context of the owner.

enabled bool

Is this query enabled? Enabled queries can be executed, disable queries cannot.

heapSizeGb double

How much heap should be allocated to this query?

bufferPoolToHeapRatio double

detailedGCLoggingEnabled bool

extraJvmArguments string repeated

Extra JVM arguments for this query.

extraEnvironmentVariables string repeated

Extra environment variables for this query.

classPathAdditions string repeated

Extra paths to include in the queries class path. The class paths are included at the beginning of the worker's classpath, thus overriding the default classes and resources.

serverName string

The server to execute on. The server name is not a hostname, but rather a string used by the Controller to map to an underlying query dispatcher. For example, "Query_1" could map to the first query server or "Auto_Merge" could map to a server selection provider for merge servers.

adminGroups string repeated

Groups that may administer the query. Administrators may change the query configuration, stop and start it, and view tables without ACL application.

viewerGroups string repeated

Groups that may view the query.

restartUsers RestartUsersEnum

Controls the behavior of who can restart the query (admins, viewers, or viewers when down).

scriptCode string

The text of the query's startup script.

scriptPath string

A path to the query's startup script in the controller's Git repository.

scriptLanguage string

The query's script language. Groovy or Python are supported.

configurationType string

What kind of query is this. Typical values are "Script" or "RunAndDone".

typeSpecificFieldsJson string optional

JSON representing the fields for this configuration type. The content of this field is dependent on configurationType.

scheduling string repeated

An array of Strings that define when the query starts and stops.

timeoutNanos int64

How many nanoseconds to allow the query to initialize (or execute for batch queries).

jvmProfile string

The jvm profile used by the query.

lastModifiedByAuthenticated string

The authenticated user that last modified the configuration.

lastModifiedByEffective string

The effective user that last modified the configuration.

lastModifiedTimeNanos int64

The last time the query was modified, in nanoseconds since the epoch.

completedStatus string

The status of a temporary query that has entered a terminal state.

expirationTimeNanos int64

When this temporary query should be removed, in nanoseconds since the epoch.

kubernetesControl string

A JSON string that is used by the dispatcher to customize the worker’s pod when deployed on Kubernetes.

workerKind string

What kind of worker is this. DeephavenEnterprise for Legacy workers. DeephavenCommunity for Core+ workers.

createdTimeNanos int64

The query creation time, in nanoseconds since the epoch.

replicaCount int32

The number of replicas to create and spread load across

spareCount int32

The number of spare workers to create and use as spares to replace failed replicas

assignmentPolicy string

The policy the controller should use to assign clients to individual replicas

assignmentPolicyParams string optional

The policy parameters

additionalMemoryGb double

How much memory beyond the JVM should be allocated to this query?

pythonControl string

Core+ Python virtual environment control

genericWorkerControl string

Generic worker control JSON

PersistentQueryInfoMessage

FieldTypeLabelDescription
config PersistentQueryConfigMessage

state PersistentQueryStateMessage optional

replicas PersistentQueryStateMessage repeated

spares PersistentQueryStateMessage repeated

PersistentQueryStateMessage

FieldTypeLabelDescription
serial int64

version int64

status PersistentQueryStatusEnum

initializationStartNanos int64

initializationCompleteNanos int64

lastUpdateNanos int64

dispatcherHost string

tableGroups NamedStringList repeated

scopeTypes ExportedObjectInfoMessage repeated

connectionDetails ProcessorConnectionDetailsMessage optional

exceptionDetails io.deephaven.proto.common.ExceptionDetailsMessage optional

typeSpecificStateJson string

Encoded JSON

lastAuthenticatedUser string

lastEffectiveUser string

scriptLoaderStateJson string optional

Encoded JSON

hasProgress bool

progressValue int32

progressMessage string

engineVersion string

dispatcherPort int32

shouldStopNanos int64

numFailures int32

lastFailureTimeNanos int64

replicaSlot int32

statusDetails string

ProcessorConnectionDetailsMessage

FieldTypeLabelDescription
protocols WorkerProtocolMessage repeated

workerName string

processInfoId string

processorHost string

envoyPrefix string

grpcUrl string

staticUrl string

enterpriseWebSocketUrl string

WorkerProtocolMessage

FieldTypeLabelDescription
name string

port int32

ExportedObjectTypeEnum

NameNumberDescription
EOT_UNSPECIFIED 0

EOT_TABLE 1

EOT_TREE_TABLE 2

EOT_TABLE_MAP 3

EOT_FIGURE 4

EOT_OTHER_WIDGET 5

EOT_PARAMETERIZED_QUERY 6

EOT_PANDAS 7

EOT_NON_DISPLAYABLE 8

PersistentQueryStatusEnum

NameNumberDescription
PQS_UNSPECIFIED 0

PQS_UNINITIALIZED 1

PQS_CONNECTING 2

PQS_AUTHENTICATING 3

PQS_ACQUIRING_WORKER 4

PQS_INITIALIZING 5

PQS_RUNNING 6

PQS_FAILED 7

PQS_ERROR 8

PQS_DISCONNECTED 9

PQS_STOPPING 10

PQS_STOPPED 11

PQS_COMPLETED 12

PQS_EXECUTING 13

RestartUsersEnum

Deephaven data types

NameNumberDescription
RU_UNSPECIFIED 0

RU_ADMIN 1

RU_ADMIN_AND_VIEWERS 2

RU_RESERVED_1 3

RU_VIEWERS_WHEN_DOWN 4

deephaven_enterprise/proto/registry.proto

Top

UpdateWorkersRequest

FieldTypeLabelDescription
id string

workers WorkerInfo repeated

UpdateWorkersResponse

WorkerInfo

FieldTypeLabelDescription
host string

port int32

nonce int64

workerKind WorkerKind

WorkerKind

NameNumberDescription
WK_UNSPECIFIED 0

The zero valued item is the default for a field of an enum type when not set; we want to ensure they are always set and plan to treat this default as an error.
WK_ENTERPRISE 1

WK_DND 2

deephaven_enterprise/proto/registry_service.proto

Top

RegistryApi

Remoting for the ServiceRegistry interface.

Method NameRequest TypeResponse TypeDescription
about .io.deephaven.proto.common.AboutRequest .io.deephaven.proto.common.AboutReply

updateWorkers .io.deephaven.proto.registry.UpdateWorkersRequest .io.deephaven.proto.registry.UpdateWorkersResponse

deephaven_enterprise/proto/routing.proto

Top

AllDataImportServiceDestinationConfigsRequest

Request for all DataImportServiceDestinationConfigs

AllLogAggregatorConfigRequest

Request for all LogAggregatorConfigs

AllTableDataServiceConfigRequest

Request for all TableDataServiceConfigs

ClaimsFilterMessage

A filter representing the claimed-by-claimant filter, against the global list of claims

FieldTypeLabelDescription
claimant string

claims ClaimsMessage

ClaimsMessage

"Global" collection of all claims made in the configuration

FieldTypeLabelDescription
namespaceClaims ClaimsMessage.NamespaceClaimsEntry repeated

namespace to claimant

tableClaims ClaimsMessage.TableClaimsEntry repeated

namespace to (table to claimant)

ClaimsMessage.NamespaceClaimsEntry

FieldTypeLabelDescription
key string

value string

ClaimsMessage.TableClaimsEntry

FieldTypeLabelDescription
key string

value TableClaimMessage

CollectedClaimsRequest

========== DataRoutingService metadata ======================================

empty

CollectedClaimsResponse

FieldTypeLabelDescription
collectedClaims ClaimsMessage

DataImportServiceConfigMessage

Message conveying a DataImportServiceConfig

FieldTypeLabelDescription
name string

intradayDirectoryName string

int32 port = 2; // obsolete int32 tailerPort = 3; // obsolete

filter FilterMessage

storageRoot google.protobuf.StringValue

definitionStorageRoot string

webserverParameters WebserverParametersMessage

properties DataImportServiceConfigMessage.PropertiesEntry repeated

endpointConfig DataImportServiceEndpointConfigMessage

bool isTableDataPortEnabled = 11; // obsolete bool isTailerPortEnabled = 12; // obsolete

group google.protobuf.StringValue

claims MyClaimsMessage

storageName string

DataImportServiceConfigMessage.PropertiesEntry

FieldTypeLabelDescription
key string

value string

DataImportServiceConfigsRequest

Request for DataImportServiceConfigs

FieldTypeLabelDescription
name string

excludeCore bool

DataImportServiceConfigsResponse

Response to request for DataImportServiceConfigs

FieldTypeLabelDescription
configMessage DataImportServiceConfigMessage repeated

DataImportServiceDestinationConfigResponse

Response to request for DataImportServiceDestinationConfigs

FieldTypeLabelDescription
endpointConfig DataImportServiceEndpointConfigMessage

DataImportServiceDestinationConfigsRequest

Request for DataImportServiceDestinationConfigs

FieldTypeLabelDescription
tableIdentifier TableIdentifierMessage

DataImportServiceEndpointConfigMessage

endpoint configuration with additional DIS fields

FieldTypeLabelDescription
endpointConfig EndpointConfigMessage

throttleKBps int32

DataRoutingConfigurationChangeMessage

Message indicating that the data routing config has changed.

The actual changes must be requested via another channel.

This message is also used as a keep-alive heartbeat, indicated by an unchanged wrt value.

FieldTypeLabelDescription
clientId int64

wrt int64

DataRoutingConfigurationChangeNotificationRequest

Request to begin listening for routing config changes

FieldTypeLabelDescription
clientId int64

DataRoutingConfigurationRequest

Message requesting the current DataRoutingService configuration - main file plus additional DISes

DataRoutingConfigurationResponse

Message conveying the current DataRoutingService file and additional DISes

FieldTypeLabelDescription
yml string

the main routing file, as a yaml string

disConfigs DataRoutingConfigurationResponse.DisConfigsEntry repeated

additional DIS configurations, by name

DataRoutingConfigurationResponse.DisConfigsEntry

FieldTypeLabelDescription
key string

value DataImportServiceConfigMessage

DataRoutingFileRequest

Message requesting the current DataRoutingService file (not additional DISes)

DataRoutingFileUpdateRequest

Request to update the main data routing file with the ymldata content

FieldTypeLabelDescription
ymldata bytes

user string

code string

comment string

DataRoutingFileUpdateResponse

Response to DataRoutingFileUpdateRequest

DataRoutingUpdateDataImportServiceConfigsMessage

Request to update one or more items comprising the data routing configuration.

This is a composite message that may be used to add DISes, update or remove DISes, replace all DISes,

and optionally update the main routing file at the same time for an atomic change.

FieldTypeLabelDescription
configToAdd DataImportServiceConfigMessage repeated

DIS Configs to add. These must not already exist.

configToUpdate DataImportServiceConfigMessage repeated

DIS Configs to update (update or replace/clobber)

configToRemove string repeated

DIS Configs to remove.

removeOthers bool

when replacing/clobbering, remove all other DISes not in the update list

lenient bool

allow certain errors, such as deleting a non-existent DIS

user string

code string

comment string

ignoreErrors bool

ignore parsing errors

routingYmlString google.protobuf.StringValue

the main routing file, as a yaml string

EndpointConfigMessage

general endpoint configuration

FieldTypeLabelDescription
name string

serviceRegistryType string

properties EndpointConfigMessage.PropertiesEntry repeated

EndpointConfigMessage.PropertiesEntry

FieldTypeLabelDescription
key string

value string

FilterMessage

Message conveying a DataRoutingService.Filter

FieldTypeLabelDescription
yml string

serialized filter

claimsFilter ClaimsFilterMessage

fully formed claims filter

ifNotClaimedFilter IfNotClaimedFilterMessage

fully formed ifNotClaimed filter

listFilter ListFilterMessage

List filter

IfNotClaimedFilterMessage

A filter representing if-not-claimed then my-filter filter, using the global list of claims

FieldTypeLabelDescription
claims ClaimsMessage

filter FilterMessage

ListFilterMessage

A list of filters. Keep the proto parsing going for another level

FieldTypeLabelDescription
filter FilterMessage repeated

LogAggregatorConfigMessage

Message conveying a LogAggregatorConfig

FieldTypeLabelDescription
name string

description google.protobuf.StringValue

port int32

obsolete

filter FilterMessage

properties LogAggregatorConfigMessage.PropertiesEntry repeated

endpointConfig LogAggregatorEndpointConfigMessage

LogAggregatorConfigMessage.PropertiesEntry

FieldTypeLabelDescription
key string

value string

LogAggregatorConfigRequest

Request for LogAggregatorConfig

FieldTypeLabelDescription
name string

LogAggregatorConfigResponse

Response to request for LogAggregatorConfig

FieldTypeLabelDescription
configMessage LogAggregatorConfigMessage

LogAggregatorDestinationConfigRequest

Request for LogAggregatorEndpointConfig

FieldTypeLabelDescription
tableIdentifier TableIdentifierMessage

LogAggregatorDestinationConfigResponse

Response to request for LogAggregatorEndpointConfig

FieldTypeLabelDescription
endpointConfig LogAggregatorEndpointConfigMessage

LogAggregatorEndpointConfigMessage

endpoint configuration with additional LAS fields

FieldTypeLabelDescription
endpointConfig EndpointConfigMessage

MyClaimsMessage

The specific claims made by a single DIS

FieldTypeLabelDescription
namespaces string repeated

tables MyClaimsMessage.TableId repeated

MyClaimsMessage.TableId

FieldTypeLabelDescription
namespace string

tableName string

TableClaimMessage

Component of ClaimsMessage, a claimed table associated with a namespace

FieldTypeLabelDescription
tableClaims TableClaimMessage.TableClaimsEntry repeated

table to claimant

TableClaimMessage.TableClaimsEntry

FieldTypeLabelDescription
key string

value string

TableDataServiceConfigMessage

Message conveying a DataRoutingService.TableDataServiceConfig

FieldTypeLabelDescription
name string

filter FilterMessage

storageRoot google.protobuf.StringValue

description google.protobuf.StringValue

tags string repeated

port google.protobuf.Int32Value

obsolete

properties TableDataServiceConfigMessage.PropertiesEntry repeated

property provider

endpointConfig EndpointConfigMessage

delegate TableDataServiceConfigMessage repeated

storageName google.protobuf.StringValue

TableDataServiceConfigMessage.PropertiesEntry

FieldTypeLabelDescription
key string

value string

TableDataServiceConfigRequest

Request for a TableDataServiceConfig

FieldTypeLabelDescription
name string

TableDataServiceConfigResponse

Response to request for TableDataServiceConfig

FieldTypeLabelDescription
tdsConfig TableDataServiceConfigMessage

collectedClaims ClaimsMessage

TableDataServiceConfigsResponse

Response to request for multiple(all) DataRoutingService.TableDataServiceConfigs

FieldTypeLabelDescription
collectedClaims ClaimsMessage

tdsConfig TableDataServiceConfigMessage repeated

TableDataServiceMessage

Message conveying a DataRoutingService.TableDataService

TODO

TableDataServiceRequest

Request for a TableDataService

FieldTypeLabelDescription
name string

TableDataServiceResponse

Response to request for a TableDataService

FieldTypeLabelDescription
tds TableDataServiceMessage

TableIdentifierMessage

Message conveying a TableIdentifier

FieldTypeLabelDescription
namespace google.protobuf.StringValue

tableName google.protobuf.StringValue

namespaceSet io.deephaven.proto.common.NamespaceSetEnum

WebserverParametersMessage

Message conveying JettyServerHelper.Parameters data

FieldTypeLabelDescription
mainClassName string

enabled bool

authenticationRequired bool

sslRequired bool

port int32

deephaven_enterprise/proto/routing_service.proto

Top

RoutingApi

Remoting for the DataRoutingService interface.

Method NameRequest TypeResponse TypeDescription
about .io.deephaven.proto.common.AboutRequest .io.deephaven.proto.common.AboutReply

========== DataRoutingService metadata ====================================
getFile .io.deephaven.proto.routing.DataRoutingFileRequest .google.protobuf.StringValue

this is just a workaround pending more TDS serialization work
getFullConfiguration .io.deephaven.proto.routing.DataRoutingConfigurationRequest .io.deephaven.proto.routing.DataRoutingConfigurationResponse

getCollectedClaims .io.deephaven.proto.routing.CollectedClaimsRequest .io.deephaven.proto.routing.CollectedClaimsResponse

getDataImportServiceConfigs .io.deephaven.proto.routing.DataImportServiceConfigsRequest .io.deephaven.proto.routing.DataImportServiceConfigsResponse

Implements DataImportServiceConfig getDataImportServiceConfig(@NotNull String name);
getDataImportServiceDestinationConfigs .io.deephaven.proto.routing.DataImportServiceDestinationConfigsRequest .io.deephaven.proto.routing.DataImportServiceDestinationConfigResponse stream

Implements Collection<? extends DataImportServiceEndpointConfig> getDataImportServiceDestinations(@NotNull TableIdentifier tableIdentifier);
getAllDataImportServiceDestinationConfigs .io.deephaven.proto.routing.AllDataImportServiceDestinationConfigsRequest .io.deephaven.proto.routing.DataImportServiceDestinationConfigResponse stream

Implements Collection<? extends DataImportServiceEndpointConfig> getAllDataImportServiceDestinationConfigs();
getLogAggregatorConfig .io.deephaven.proto.routing.LogAggregatorConfigRequest .io.deephaven.proto.routing.LogAggregatorConfigResponse

Implements Config getLogAggregatorConfig(@NotNull String configName);
getAllLogAggregatorServiceConfigs .io.deephaven.proto.routing.AllLogAggregatorConfigRequest .io.deephaven.proto.routing.LogAggregatorConfigResponse stream

Implements Collection<? extends LogAggregatorConfig> getAllLogAggregatorServiceConfigs();
getLogAggregatorDestinationConfig .io.deephaven.proto.routing.LogAggregatorDestinationConfigRequest .io.deephaven.proto.routing.LogAggregatorDestinationConfigResponse

Implements LogAggregatorEndpoint getLogAggregatorDestinationConfig(@NotNull TableIdentifier tableIdentifier);
getTableDataServiceConfig .io.deephaven.proto.routing.TableDataServiceConfigRequest .io.deephaven.proto.routing.TableDataServiceConfigResponse

Implements TableDataServiceConfig getTableDataServiceConfig(@NotNull String name);
getTableDataServiceConfigs .io.deephaven.proto.routing.AllTableDataServiceConfigRequest .io.deephaven.proto.routing.TableDataServiceConfigsResponse

Implements Collection<? extends TableDataServiceConfig> getTableDataServiceConfigs();
updateFile .io.deephaven.proto.routing.DataRoutingFileUpdateRequest .io.deephaven.proto.routing.DataRoutingFileUpdateResponse

Update the contents of the data routing file
updateDises .io.deephaven.proto.routing.DataRoutingUpdateDataImportServiceConfigsMessage .io.deephaven.proto.routing.DataRoutingFileUpdateResponse

Update one or more items comprising the data routing configuration. According to the request message, add DISes, update or remove DISes, replace all DISes, and optionally update the main routing file at the same time for an atomic change.
subscribeToDataRoutingChangeNotifications .io.deephaven.proto.routing.DataRoutingConfigurationChangeNotificationRequest .io.deephaven.proto.routing.DataRoutingConfigurationChangeMessage stream

========== change notification =======================================

deephaven_enterprise/proto/schema.proto

Top

ListAllTablesRequest

NamespaceRequest

FieldTypeLabelDescription
name string

namespaceSet NamespaceSet

only valid for create

code string

comment string

NamespaceSetReply

FieldTypeLabelDescription
set NamespaceSet

NamespaceSetRequest

FieldTypeLabelDescription
namespaceSet NamespaceSet

SchemaItem

FieldTypeLabelDescription
schema bytes

copySchema google.protobuf.BytesValue

SchemaReply

FieldTypeLabelDescription
item SchemaItem

SchemaRequest

FieldTypeLabelDescription
namespace string

tableName string

version int64

action Action

schema SchemaItem

code string

comment string

SchemasRequest

FieldTypeLabelDescription
namespaceSet NamespaceSet

namespace string

TableNameReply

FieldTypeLabelDescription
namespaceSet NamespaceSet

namespace string

tableName string

Action

NameNumberDescription
Get 0

Create 1

Update 2

Delete 3

NamespaceSet

NameNumberDescription
Unset 0

System 1

User 2

DoesNotExist 3

deephaven_enterprise/proto/schema_service.proto

Top

SchemaApi

Remoting for the Schema Service.

Method NameRequest TypeResponse TypeDescription
about .io.deephaven.proto.common.AboutRequest .io.deephaven.proto.common.AboutReply

return a string with information about the server side context
authenticate .io.deephaven.proto.common.AuthRequest .io.deephaven.proto.common.AuthReply

Authenticate using the AuthToken in the AuthRequest. This can be used to remove authentication. The client will hold on to this authenticated context for subsequent calls.
putSchema .io.deephaven.proto.schema.SchemaRequest .io.deephaven.proto.schema.SchemaReply

TODO: there's a choice to make - mimic the SchemaService API, or provide building blocks e.g. putSchema with SchemaRequest that differentiates between add and update
getSchema .io.deephaven.proto.schema.SchemaRequest .io.deephaven.proto.schema.SchemaReply

getSchemas .io.deephaven.proto.schema.SchemasRequest .io.deephaven.proto.schema.SchemaReply stream

containsSchema .io.deephaven.proto.schema.SchemaRequest .google.protobuf.BoolValue

rpc listSchemas(SchemasRequest) returns (stream StringReply) {}
getNamespaceSet .io.deephaven.proto.schema.NamespaceRequest .io.deephaven.proto.schema.NamespaceSetReply

listNamespaces .io.deephaven.proto.schema.NamespaceSetRequest .google.protobuf.StringValue stream

rpc NamespaceSet getNamespaceSet(@NotNull String namespace) throws IllegalArgumentException;
listTableNames .io.deephaven.proto.schema.NamespaceRequest .google.protobuf.StringValue stream

listAllTables .io.deephaven.proto.schema.ListAllTablesRequest .io.deephaven.proto.schema.TableNameReply stream

containsNamespace .io.deephaven.proto.schema.NamespaceRequest .google.protobuf.BoolValue

createNamespace .io.deephaven.proto.schema.NamespaceRequest .google.protobuf.BoolValue

removeNamespace .io.deephaven.proto.schema.NamespaceRequest .google.protobuf.BoolValue

deephaven_enterprise/proto/serviceregistry.proto

Top

GetAllConfigsRequest

GetAllConfigsResponse

FieldTypeLabelDescription
endpointConfigs RoutingEndpointConfigMessage repeated

GetConfigsRequest

FieldTypeLabelDescription
name string

GetConfigsResponse

FieldTypeLabelDescription
endpointConfigs RoutingEndpointConfigMessage repeated

RegisterRoutingEndpointConfigRequest

FieldTypeLabelDescription
leaseId google.protobuf.Int64Value

endpointConfig RoutingEndpointConfigMessage

RegisterRoutingEndpointConfigResponse

FieldTypeLabelDescription
leaseId int64

name string

leaseTtl int32

leaseRenewSeconds int32

leaseRenewRetryDelay int32

RenewLeaseRequest

FieldTypeLabelDescription
name string

leaseId int64

RenewLeaseResponse

FieldTypeLabelDescription
success bool

RevokeLeaseRequest

FieldTypeLabelDescription
name string

leaseId int64

RevokeLeaseResponse

RoutingEndpointConfigMessage

FieldTypeLabelDescription
name string

endpointId string

host string

port int32

processId string

RoutingEndpointConfigRequest

FieldTypeLabelDescription
name string

endpointId string

RoutingEndpointConfigResponse

FieldTypeLabelDescription
endpointConfig RoutingEndpointConfigMessage

deephaven_enterprise/proto/table_definition.proto

Top

ColumnDefinitionMessage

FieldTypeLabelDescription
name string

dataType string

componentType string optional

columnType ColumnTypeEnum optional

isVarSizeString bool

encoding EncodingTypeEnum optional

codec string optional

codecArgs string optional

objectWidthBytes int32 optional

TableDefinitionMessage

FieldTypeLabelDescription
namespace string optional

tableName string optional

columns ColumnDefinitionMessage repeated

storageType StorageTypeEnum optional

ColumnTypeEnum

NameNumberDescription
CT_UNSPECIFIED 0

CT_NORMAL 1

CT_GROUPING 2

CT_PARTITIONING 4

CT_VIRTUAL 8

EncodingTypeEnum

NameNumberDescription
ET_UNSPECIFIED 0

ET_ISO_8859_1 1

ET_UTF_8 2

ET_US_ASCII 4

ET_UTF_16 8

ET_UTF_16BE 16

ET_UTF_16LE 32

StorageTypeEnum

NameNumberDescription
ST_UNSPECIFIED 0

ST_IN_MEMORY 1

ST_NESTED_PARTITIONED_ON_DISK 2

ST_SPLAYED_ON_DISK 4

ST_EXTENDED 8

deephaven_enterprise/proto/unified.proto

Top

deephaven_enterprise/proto/unified_service.proto

Top

UnifiedApi

Remoting for the Unified API

Method NameRequest TypeResponse TypeDescription
about .io.deephaven.proto.common.AboutRequest .io.deephaven.proto.common.AboutReply

authenticate .io.deephaven.proto.common.AuthRequest .io.deephaven.proto.common.AuthReply

Authenticate using the AuthToken in the AuthRequest. This can be used to remove authentication. The client will hold on to this authenticated context for subsequent calls.

serviceregistry_service.proto

Top

ServiceRegistryApi

Remoting for the ServiceRegistry interface.

Method NameRequest TypeResponse TypeDescription
about .io.deephaven.proto.common.AboutRequest .io.deephaven.proto.common.AboutReply

registerEndpointConfig .io.deephaven.proto.serviceregistry.RegisterRoutingEndpointConfigRequest .io.deephaven.proto.serviceregistry.RegisterRoutingEndpointConfigResponse

revokeLease .io.deephaven.proto.serviceregistry.RevokeLeaseRequest .io.deephaven.proto.serviceregistry.RevokeLeaseResponse

renewLease .io.deephaven.proto.serviceregistry.RenewLeaseRequest .io.deephaven.proto.serviceregistry.RenewLeaseResponse

getEndpointConfig .io.deephaven.proto.serviceregistry.RoutingEndpointConfigRequest .io.deephaven.proto.serviceregistry.RoutingEndpointConfigResponse

getEndpointConfigs .io.deephaven.proto.serviceregistry.GetConfigsRequest .io.deephaven.proto.serviceregistry.GetConfigsResponse

getAllEndpointConfigs .io.deephaven.proto.serviceregistry.GetAllConfigsRequest .io.deephaven.proto.serviceregistry.GetAllConfigsResponse

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
double double double float float64 double float Float
float float float float float32 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 int32 int integer Bignum or Fixnum (as required)
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 int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)