deephaven_enterprise.proto.controller_pb2¶

Module Contents¶

class AddQueryRequest(*, cookie=..., config=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
config (deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CONFIG_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

property config: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage[source]¶

Return type:: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage

cookie: bytes[source]¶

class AddQueryResponse(*, querySerial=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: querySerial (int)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

QUERYSERIAL_FIELD_NUMBER: int[source]¶

querySerial: int[source]¶

class AssignmentPolicyConfigMessage(*, name=..., displayName=..., description=..., acceptsParameters=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
displayName (str)
description (str | None)
acceptsParameters (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ACCEPTSPARAMETERS_FIELD_NUMBER: int[source]¶

DESCRIPTION_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

DISPLAYNAME_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

acceptsParameters: bool[source]¶

description: str[source]¶

displayName: str[source]¶

name: str[source]¶

class AuthenticationRequest(*, token=..., clientId=..., getConfiguration=...)[source]¶

Bases: google.protobuf.message.Message

Controller API messages

Parameters:

token (deephaven_enterprise.proto.auth_pb2.Token | None)
clientId (deephaven_enterprise.proto.auth_pb2.ClientId | None)
getConfiguration (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CLIENTID_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

GETCONFIGURATION_FIELD_NUMBER: int[source]¶

TOKEN_FIELD_NUMBER: int[source]¶

property clientId: deephaven_enterprise.proto.auth_pb2.ClientId[source]¶

Return type:: deephaven_enterprise.proto.auth_pb2.ClientId

getConfiguration: bool[source]¶

property token: deephaven_enterprise.proto.auth_pb2.Token[source]¶

Return type:: deephaven_enterprise.proto.auth_pb2.Token

class AuthenticationResponse(*, authenticated=..., cookie=..., config=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

authenticated (bool)
cookie (bytes)
config (Global___ControllerConfigurationMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

AUTHENTICATED_FIELD_NUMBER: int[source]¶

CONFIG_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

authenticated: bool[source]¶

property config: Global___ControllerConfigurationMessage[source]¶

Return type:: Global___ControllerConfigurationMessage

cookie: bytes[source]¶

class ConsoleConfigurationTypeMessage(*, name=..., displayName=..., displayable=..., properties=..., hasScript=..., serverClasses=..., allowedGroups=..., extraColumns=..., typeSpecificWireConfigJSON=..., configCheckerClass=..., configPanelFactoryClass=..., customActionProviderClass=..., setupQueryClass=..., configClass=..., shutdownProcedureClass=..., extraJvmArgsClass=..., configProcessorClass=..., extraColumnGetterClass=..., popupProviderClass=..., configTypeDetailsClass=..., communityInitializerClass=..., hasScriptLanguage=..., communityRequestProcessorClass=..., supportsReplicas=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
displayName (str)
displayable (bool)
properties (collections.abc.Mapping[str, str] | None)
hasScript (bool)
serverClasses (collections.abc.Iterable[str] | None)
allowedGroups (collections.abc.Iterable[str] | None)
extraColumns (collections.abc.Iterable[Global___ExtraColumnMessage] | None)
typeSpecificWireConfigJSON (str | None)
configCheckerClass (str)
configPanelFactoryClass (str)
customActionProviderClass (str)
setupQueryClass (str)
configClass (str)
shutdownProcedureClass (str)
extraJvmArgsClass (str)
configProcessorClass (str)
extraColumnGetterClass (str)
popupProviderClass (collections.abc.Iterable[str] | None)
configTypeDetailsClass (str)
communityInitializerClass (str)
hasScriptLanguage (bool)
communityRequestProcessorClass (str)
supportsReplicas (bool)

class PropertiesEntry(*, key=..., value=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

key (str)
value (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

KEY_FIELD_NUMBER: int[source]¶

VALUE_FIELD_NUMBER: int[source]¶

key: str[source]¶

value: str[source]¶

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

ALLOWEDGROUPS_FIELD_NUMBER: int[source]¶

COMMUNITYINITIALIZERCLASS_FIELD_NUMBER: int[source]¶

COMMUNITYREQUESTPROCESSORCLASS_FIELD_NUMBER: int[source]¶

CONFIGCHECKERCLASS_FIELD_NUMBER: int[source]¶

CONFIGCLASS_FIELD_NUMBER: int[source]¶

CONFIGPANELFACTORYCLASS_FIELD_NUMBER: int[source]¶

CONFIGPROCESSORCLASS_FIELD_NUMBER: int[source]¶

CONFIGTYPEDETAILSCLASS_FIELD_NUMBER: int[source]¶

CUSTOMACTIONPROVIDERCLASS_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

DISPLAYABLE_FIELD_NUMBER: int[source]¶

DISPLAYNAME_FIELD_NUMBER: int[source]¶

EXTRACOLUMNGETTERCLASS_FIELD_NUMBER: int[source]¶

EXTRACOLUMNS_FIELD_NUMBER: int[source]¶

EXTRAJVMARGSCLASS_FIELD_NUMBER: int[source]¶

HASSCRIPTLANGUAGE_FIELD_NUMBER: int[source]¶

HASSCRIPT_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

POPUPPROVIDERCLASS_FIELD_NUMBER: int[source]¶

PROPERTIES_FIELD_NUMBER: int[source]¶

SERVERCLASSES_FIELD_NUMBER: int[source]¶

SETUPQUERYCLASS_FIELD_NUMBER: int[source]¶

SHUTDOWNPROCEDURECLASS_FIELD_NUMBER: int[source]¶

SUPPORTSREPLICAS_FIELD_NUMBER: int[source]¶

TYPESPECIFICWIRECONFIGJSON_FIELD_NUMBER: int[source]¶

property allowedGroups: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

communityInitializerClass: str[source]¶

communityRequestProcessorClass: str[source]¶

configCheckerClass: str[source]¶

configClass: str[source]¶

configPanelFactoryClass: str[source]¶

configProcessorClass: str[source]¶

configTypeDetailsClass: str[source]¶

customActionProviderClass: str[source]¶

displayName: str[source]¶

displayable: bool[source]¶

extraColumnGetterClass: str[source]¶

property extraColumns: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ExtraColumnMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ExtraColumnMessage]

extraJvmArgsClass: str[source]¶

hasScript: bool[source]¶

hasScriptLanguage: bool[source]¶

name: str[source]¶

property popupProviderClass: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property properties: google.protobuf.internal.containers.ScalarMap[str, str][source]¶

Return type:: google.protobuf.internal.containers.ScalarMap[str, str]

property serverClasses: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

setupQueryClass: str[source]¶

shutdownProcedureClass: str[source]¶

supportsReplicas: bool[source]¶

typeSpecificWireConfigJSON: str[source]¶

class ControllerConfigurationMessage(*, maxHeapSizeGb=..., minDataBufferPoolRatio=..., maxDataBufferPoolRatio=..., configurationTypes=..., temporaryQueueDetails=..., defaultTempQueueName=..., dbServers=..., defaultSchedulingDetails=..., scheduleLookForwardDays=..., publicKey=..., algorithm=..., consoleServerGroups=..., jvmProfileNames=..., defaultJvmProfileName=..., dataRoutingImplName=..., tdsConfigs=..., disConfigs=..., lasConfigs=..., assignmentPolicies=..., defaultAssignmentPolicyName=..., defaultAssignmentPolicyParams=..., supported_worker_kinds=..., default_worker_kind=..., min_heap_size_gb=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

maxHeapSizeGb (int)
minDataBufferPoolRatio (float)
maxDataBufferPoolRatio (float)
configurationTypes (collections.abc.Iterable[Global___ConsoleConfigurationTypeMessage] | None)
temporaryQueueDetails (collections.abc.Iterable[Global___ControllerTempQueueDetailsMessage] | None)
defaultTempQueueName (str)
dbServers (collections.abc.Iterable[Global___PQDBServerConfigMessage] | None)
defaultSchedulingDetails (collections.abc.Iterable[str] | None)
scheduleLookForwardDays (int)
publicKey (bytes)
algorithm (str)
consoleServerGroups (collections.abc.Iterable[deephaven_enterprise.proto.controller_common_pb2.NamedStringList] | None)
jvmProfileNames (collections.abc.Iterable[str] | None)
defaultJvmProfileName (str)
dataRoutingImplName (str)
tdsConfigs (collections.abc.Iterable[Global___RoutingConfigMessage] | None)
disConfigs (collections.abc.Iterable[Global___RoutingConfigMessage] | None)
lasConfigs (collections.abc.Iterable[Global___RoutingConfigMessage] | None)
assignmentPolicies (collections.abc.Iterable[Global___AssignmentPolicyConfigMessage] | None)
defaultAssignmentPolicyName (str)
defaultAssignmentPolicyParams (str)
supported_worker_kinds (collections.abc.Iterable[Global___WorkerKind] | None)
default_worker_kind (str)
min_heap_size_gb (float)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

ALGORITHM_FIELD_NUMBER: int[source]¶

ASSIGNMENTPOLICIES_FIELD_NUMBER: int[source]¶

CONFIGURATIONTYPES_FIELD_NUMBER: int[source]¶

CONSOLESERVERGROUPS_FIELD_NUMBER: int[source]¶

DATAROUTINGIMPLNAME_FIELD_NUMBER: int[source]¶

DBSERVERS_FIELD_NUMBER: int[source]¶

DEFAULTASSIGNMENTPOLICYNAME_FIELD_NUMBER: int[source]¶

DEFAULTASSIGNMENTPOLICYPARAMS_FIELD_NUMBER: int[source]¶

DEFAULTJVMPROFILENAME_FIELD_NUMBER: int[source]¶

DEFAULTSCHEDULINGDETAILS_FIELD_NUMBER: int[source]¶

DEFAULTTEMPQUEUENAME_FIELD_NUMBER: int[source]¶

DEFAULT_WORKER_KIND_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

DISCONFIGS_FIELD_NUMBER: int[source]¶

JVMPROFILENAMES_FIELD_NUMBER: int[source]¶

LASCONFIGS_FIELD_NUMBER: int[source]¶

MAXDATABUFFERPOOLRATIO_FIELD_NUMBER: int[source]¶

MAXHEAPSIZEGB_FIELD_NUMBER: int[source]¶

MINDATABUFFERPOOLRATIO_FIELD_NUMBER: int[source]¶

MIN_HEAP_SIZE_GB_FIELD_NUMBER: int[source]¶

PUBLICKEY_FIELD_NUMBER: int[source]¶

SCHEDULELOOKFORWARDDAYS_FIELD_NUMBER: int[source]¶

SUPPORTED_WORKER_KINDS_FIELD_NUMBER: int[source]¶

TDSCONFIGS_FIELD_NUMBER: int[source]¶

TEMPORARYQUEUEDETAILS_FIELD_NUMBER: int[source]¶

algorithm: str[source]¶

property assignmentPolicies: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___AssignmentPolicyConfigMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___AssignmentPolicyConfigMessage]

property configurationTypes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ConsoleConfigurationTypeMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ConsoleConfigurationTypeMessage]

property consoleServerGroups: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.controller_common_pb2.NamedStringList][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.controller_common_pb2.NamedStringList]

dataRoutingImplName: str[source]¶

property dbServers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___PQDBServerConfigMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___PQDBServerConfigMessage]

defaultAssignmentPolicyName: str[source]¶

defaultAssignmentPolicyParams: str[source]¶

defaultJvmProfileName: str[source]¶

property defaultSchedulingDetails: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

defaultTempQueueName: str[source]¶

default_worker_kind: str[source]¶: the default worker kind for configurations that do not have a worker kind specified; this is distinct from the default value that should be displayed in the UI, which is determined by the order of the worker kinds in the supported_worker_kinds field.

property disConfigs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RoutingConfigMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RoutingConfigMessage]

property jvmProfileNames: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property lasConfigs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RoutingConfigMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RoutingConfigMessage]

maxDataBufferPoolRatio: float[source]¶

maxHeapSizeGb: int[source]¶

minDataBufferPoolRatio: float[source]¶

min_heap_size_gb: float[source]¶

publicKey: bytes[source]¶

scheduleLookForwardDays: int[source]¶

property supported_worker_kinds: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___WorkerKind][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___WorkerKind]

property tdsConfigs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RoutingConfigMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___RoutingConfigMessage]

property temporaryQueueDetails: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ControllerTempQueueDetailsMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ControllerTempQueueDetailsMessage]

class ControllerTempQueueDetailsMessage(*, name=..., maxConcurrentQueries=..., maxHeapMb=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
maxConcurrentQueries (int)
maxHeapMb (int)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

MAXCONCURRENTQUERIES_FIELD_NUMBER: int[source]¶

MAXHEAPMB_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

maxConcurrentQueries: int[source]¶

maxHeapMb: int[source]¶

name: str[source]¶

class DeserializeQueryConfigurationRequest(*, cookie=..., xml=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
xml (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

XML_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶: the authentication cookie for this request

xml: str[source]¶: The XML to parse into a query configuration message

class DeserializeQueryConfigurationResponse(*, configs=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: configs (collections.abc.Iterable[deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

CONFIGS_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

property configs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage][source]¶

The persistent query configuration produced from the XML (or other format) in a DeserializeQueryConfigurationRequest

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage]

class DetermineDispatcherRequest(*, cookie=..., serverGroupName=..., heapSizeMb=..., workerKind=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
serverGroupName (str)
heapSizeMb (int)
workerKind (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

HEAPSIZEMB_FIELD_NUMBER: int[source]¶

SERVERGROUPNAME_FIELD_NUMBER: int[source]¶

WORKERKIND_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

heapSizeMb: int[source]¶

serverGroupName: str[source]¶

workerKind: str[source]¶

class DetermineDispatcherResponse(*, serverConfig=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: serverConfig (Global___PQDBServerConfigMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SERVERCONFIG_FIELD_NUMBER: int[source]¶

property serverConfig: Global___PQDBServerConfigMessage[source]¶

Return type:: Global___PQDBServerConfigMessage

class ExtraColumnMessage(*, name=..., rendererName=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
rendererName (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

NAME_FIELD_NUMBER: int[source]¶

RENDERERNAME_FIELD_NUMBER: int[source]¶

name: str[source]¶

rendererName: str[source]¶

class GetConfigurationRequest(*, cookie=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: cookie (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

cookie: bytes[source]¶

class GetConfigurationResponse(*, config=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: config (Global___ControllerConfigurationMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CONFIG_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

property config: Global___ControllerConfigurationMessage[source]¶

Return type:: Global___ControllerConfigurationMessage

class GetScriptPathsRequest(*, cookie=..., command=..., querySerial=..., effectiveUser=..., scriptLoaderStateJSON=..., useRelativePath=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
command (Global___ScriptCommandEnum)
querySerial (int | None)
effectiveUser (str | None)
scriptLoaderStateJSON (str | None)
useRelativePath (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_effectiveUser', b'_effectiveUser']) → Literal['effectiveUser'] | None[source]¶

WhichOneof(oneof_group: Literal['_querySerial', b'_querySerial']) → Literal['querySerial'] | None

WhichOneof(oneof_group: Literal['_scriptLoaderStateJSON', b'_scriptLoaderStateJSON']) → Literal['scriptLoaderStateJSON'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

COMMAND_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EFFECTIVEUSER_FIELD_NUMBER: int[source]¶

QUERYSERIAL_FIELD_NUMBER: int[source]¶

SCRIPTLOADERSTATEJSON_FIELD_NUMBER: int[source]¶

USERELATIVEPATH_FIELD_NUMBER: int[source]¶

command: Global___ScriptCommandEnum[source]¶

cookie: bytes[source]¶

effectiveUser: str[source]¶

querySerial: int[source]¶

scriptLoaderStateJSON: str[source]¶

useRelativePath: bool[source]¶

class GetScriptPathsResponse(*, results=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: results (collections.abc.Iterable[str] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULTS_FIELD_NUMBER: int[source]¶

property results: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class GetScriptRequest(*, cookie=..., command=..., querySerial=..., effectiveUser=..., scriptLoaderStateJSON=..., scriptPath=..., useRelativePath=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
command (Global___ScriptCommandEnum)
querySerial (int | None)
effectiveUser (str | None)
scriptLoaderStateJSON (str | None)
scriptPath (str)
useRelativePath (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_effectiveUser', b'_effectiveUser']) → Literal['effectiveUser'] | None[source]¶

WhichOneof(oneof_group: Literal['_querySerial', b'_querySerial']) → Literal['querySerial'] | None

WhichOneof(oneof_group: Literal['_scriptLoaderStateJSON', b'_scriptLoaderStateJSON']) → Literal['scriptLoaderStateJSON'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

COMMAND_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EFFECTIVEUSER_FIELD_NUMBER: int[source]¶

QUERYSERIAL_FIELD_NUMBER: int[source]¶

SCRIPTLOADERSTATEJSON_FIELD_NUMBER: int[source]¶

SCRIPTPATH_FIELD_NUMBER: int[source]¶

USERELATIVEPATH_FIELD_NUMBER: int[source]¶

command: Global___ScriptCommandEnum[source]¶

cookie: bytes[source]¶

effectiveUser: str[source]¶

querySerial: int[source]¶

scriptLoaderStateJSON: str[source]¶

scriptPath: str[source]¶

useRelativePath: bool[source]¶

class GetScriptResponse(*, scriptBody=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: scriptBody (str | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SCRIPTBODY_FIELD_NUMBER: int[source]¶

scriptBody: str[source]¶

class ModifyQueryRequest(*, cookie=..., config=..., doRestart=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
config (deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage | None)
doRestart (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

CONFIG_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

DORESTART_FIELD_NUMBER: int[source]¶

property config: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage[source]¶

Return type:: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage

cookie: bytes[source]¶

doRestart: bool[source]¶

class ModifyQueryResponse[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class PQDBServerConfigMessage(*, name=..., host=..., port=..., classPushListResourceName=..., serverClass=..., maxHeapSizeGb=..., serverType=..., consoleGroups=..., serverInfo=..., console_permitted=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
host (str)
port (int)
classPushListResourceName (str | None)
serverClass (str)
maxHeapSizeGb (float)
serverType (Global___ServerTypeEnum)
consoleGroups (collections.abc.Iterable[str] | None)
serverInfo (str | None)
console_permitted (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_classPushListResourceName', b'_classPushListResourceName']) → Literal['classPushListResourceName'] | None[source]¶

WhichOneof(oneof_group: Literal['_serverInfo', b'_serverInfo']) → Literal['serverInfo'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

CLASSPUSHLISTRESOURCENAME_FIELD_NUMBER: int[source]¶

CONSOLEGROUPS_FIELD_NUMBER: int[source]¶

CONSOLE_PERMITTED_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

HOST_FIELD_NUMBER: int[source]¶

MAXHEAPSIZEGB_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

PORT_FIELD_NUMBER: int[source]¶

SERVERCLASS_FIELD_NUMBER: int[source]¶

SERVERINFO_FIELD_NUMBER: int[source]¶

SERVERTYPE_FIELD_NUMBER: int[source]¶

classPushListResourceName: str[source]¶

property consoleGroups: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Indicates which groups can start consoles on this server. Empty means any user may do this.

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

console_permitted: bool[source]¶: True if the current user is permitted to create consoles on this server

host: str[source]¶: Will always be “Group” if serverType is STE_GROUP

maxHeapSizeGb: float[source]¶

name: str[source]¶

port: int[source]¶

serverClass: str[source]¶

serverInfo: str[source]¶

serverType: Global___ServerTypeEnum[source]¶

class ReloadConfigRequest(*, cookie=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: cookie (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

cookie: bytes[source]¶

class ReloadConfigResponse[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class RemoveQueryRequest(*, cookie=..., serial=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
serial (int)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SERIAL_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

serial: int[source]¶

class RemoveQueryResponse[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class ReplicaSpecifier(*, serial=..., replica=..., spare=..., processInfoId=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

serial (int)
replica (int)
spare (int)
processInfoId (str | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal['_processInfoId', b'_processInfoId']) → Literal['processInfoId'] | None[source]¶

WhichOneof(oneof_group: Literal['id', b'id']) → Literal['replica', 'spare'] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

PROCESSINFOID_FIELD_NUMBER: int[source]¶

REPLICA_FIELD_NUMBER: int[source]¶

SERIAL_FIELD_NUMBER: int[source]¶

SPARE_FIELD_NUMBER: int[source]¶

processInfoId: str[source]¶

replica: int[source]¶

serial: int[source]¶

spare: int[source]¶

class ReplicaStatus(*, replica=..., success=..., error=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

replica (Global___ReplicaSpecifier | None)
success (bool)
error (str | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

ERROR_FIELD_NUMBER: int[source]¶

REPLICA_FIELD_NUMBER: int[source]¶

SUCCESS_FIELD_NUMBER: int[source]¶

error: str[source]¶

property replica: Global___ReplicaSpecifier[source]¶

Return type:: Global___ReplicaSpecifier

success: bool[source]¶

class RestartQueryRequest(*, cookie=..., serials=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
serials (collections.abc.Iterable[int] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SERIALS_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

property serials: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]

class RestartQueryResponse(*, successSerials=..., errorSerials=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

successSerials (collections.abc.Iterable[int] | None)
errorSerials (collections.abc.Mapping[int, str] | None)

class ErrorSerialsEntry(*, key=..., value=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

key (int)
value (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

KEY_FIELD_NUMBER: int[source]¶

VALUE_FIELD_NUMBER: int[source]¶

key: int[source]¶

value: str[source]¶

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

ERRORSERIALS_FIELD_NUMBER: int[source]¶

SUCCESSSERIALS_FIELD_NUMBER: int[source]¶

property errorSerials: google.protobuf.internal.containers.ScalarMap[int, str][source]¶

Return type:: google.protobuf.internal.containers.ScalarMap[int, str]

property successSerials: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]

class RestartReplicaRequest(*, cookie=..., replicas=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
replicas (collections.abc.Iterable[Global___ReplicaSpecifier] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

REPLICAS_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

property replicas: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaSpecifier][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaSpecifier]

class RestartReplicaResponse(*, status=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: status (collections.abc.Iterable[Global___ReplicaStatus] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

STATUS_FIELD_NUMBER: int[source]¶

property status: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaStatus][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaStatus]

class RoutingConfigMessage(*, name=..., tags=..., description=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

name (str)
tags (collections.abc.Iterable[str] | None)
description (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTION_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

NAME_FIELD_NUMBER: int[source]¶

TAGS_FIELD_NUMBER: int[source]¶

description: str[source]¶

name: str[source]¶

property tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class ScriptCommandEnum[source]¶: Bases: _ScriptCommandEnum

class SerializeQueryConfigurationRequest(*, cookie=..., configs=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
configs (collections.abc.Iterable[deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

CONFIGS_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

property configs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage][source]¶

the query configuration to serialize

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryConfigMessage]

cookie: bytes[source]¶: the authentication cookie for this request

class SerializeQueryConfigurationResponse(*, xml=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: xml (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

XML_FIELD_NUMBER: int[source]¶

xml: str[source]¶: the serialized query configuration as XML

class ServerSelectionAdminRequest(*, cookie=..., command=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
command (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COMMAND_FIELD_NUMBER: int[source]¶

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

command: str[source]¶

cookie: bytes[source]¶

class ServerSelectionAdminResponse(*, result=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: result (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

RESULT_FIELD_NUMBER: int[source]¶

result: str[source]¶

class ServerSelectionStatusRequest(*, cookie=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: cookie (bytes)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

cookie: bytes[source]¶

class ServerSelectionStatusResponse(*, status=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: status (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

STATUS_FIELD_NUMBER: int[source]¶

status: str[source]¶

class ServerTypeEnum[source]¶: Bases: _ServerTypeEnum

class StatusUpdateRequest(*, cookie=..., querySerial=..., status=..., hasExportedObjects=..., exportedObjects=..., hasTableGroups=..., tableGroups=..., processInfoId=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
querySerial (int)
status (deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryStatusEnum.ValueType | None)
hasExportedObjects (bool)
exportedObjects (collections.abc.Iterable[deephaven_enterprise.proto.persistent_query_pb2.ExportedObjectInfoMessage] | None)
hasTableGroups (bool)
tableGroups (collections.abc.Iterable[deephaven_enterprise.proto.controller_common_pb2.NamedStringList] | None)
processInfoId (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EXPORTEDOBJECTS_FIELD_NUMBER: int[source]¶

HASEXPORTEDOBJECTS_FIELD_NUMBER: int[source]¶

HASTABLEGROUPS_FIELD_NUMBER: int[source]¶

PROCESSINFOID_FIELD_NUMBER: int[source]¶

QUERYSERIAL_FIELD_NUMBER: int[source]¶

STATUS_FIELD_NUMBER: int[source]¶

TABLEGROUPS_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

property exportedObjects: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.persistent_query_pb2.ExportedObjectInfoMessage][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.persistent_query_pb2.ExportedObjectInfoMessage]

hasExportedObjects: bool[source]¶

hasTableGroups: bool[source]¶

processInfoId: str[source]¶

querySerial: int[source]¶

status: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryStatusEnum.ValueType[source]¶

property tableGroups: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.controller_common_pb2.NamedStringList][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.controller_common_pb2.NamedStringList]

class StatusUpdateResponse[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

class StopQueryRequest(*, cookie=..., serials=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
serials (collections.abc.Iterable[int] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

SERIALS_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

property serials: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]

class StopQueryResponse(*, successSerials=..., errorSerials=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

successSerials (collections.abc.Iterable[int] | None)
errorSerials (collections.abc.Mapping[int, str] | None)

class ErrorSerialsEntry(*, key=..., value=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

key (int)
value (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

KEY_FIELD_NUMBER: int[source]¶

VALUE_FIELD_NUMBER: int[source]¶

key: int[source]¶

value: str[source]¶

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

ERRORSERIALS_FIELD_NUMBER: int[source]¶

SUCCESSSERIALS_FIELD_NUMBER: int[source]¶

property errorSerials: google.protobuf.internal.containers.ScalarMap[int, str][source]¶

Return type:: google.protobuf.internal.containers.ScalarMap[int, str]

property successSerials: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int][source]¶

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[int]

class StopReplicaRequest(*, cookie=..., replicas=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
replicas (collections.abc.Iterable[Global___ReplicaSpecifier] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

REPLICAS_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

property replicas: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaSpecifier][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaSpecifier]

class StopReplicaResponse(*, status=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:: status (collections.abc.Iterable[Global___ReplicaStatus] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

STATUS_FIELD_NUMBER: int[source]¶

property status: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaStatus][source]¶

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ReplicaStatus]

class SubscribeRequest(*, cookie=..., filters=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

cookie (bytes)
filters (collections.abc.Iterable[Global___SubscriptionFilter] | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

COOKIE_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

FILTERS_FIELD_NUMBER: int[source]¶

cookie: bytes[source]¶

property filters: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___SubscriptionFilter][source]¶

Optional set of filters narrowing the subscription to a subset of the PQs the client is otherwise allowed to see. Semantics:

An empty list (the default) means “no filter”: the subscription behaves as it did before this field was added and the client receives events for every PQ visible to it.

A non-empty list is OR-combined: a PQ matches the filter iff at least one element in the list matches it.

The visibility/ACL check is always implied, the filter can only further narrow the set; it can never widen visibility.

Filtering applies only to PQ-scoped events (SE_PUT and SE_REMOVE). SE_CONFIG_UPDATE and SE_BATCH_END are control/global events and are always delivered regardless of the filter.

The filter is re-evaluated on every PQ change. A PQ that transitions into the matching set (e.g. via rename or owner change when filtering by owner and name) is delivered as SE_PUT; a PQ that transitions out is delivered as SE_REMOVE. Servers track which serials have been delivered to a given subscription so that these enter/leave transitions are emitted exactly once.

Malformed filter elements (see SubscriptionFilter) MUST cause the RPC to fail with INVALID_ARGUMENT on servers that honor this field.

Backwards-compatibility contract: a server MAY ignore this field (e.g. an older server that predates filter support, where the unknown field is silently dropped by proto3 parsing). Clients therefore MUST be prepared to apply the same filter locally to the incoming stream to guarantee correct behavior, including synthesizing the same enter/leave SE_PUT and SE_REMOVE transitions described above against a fully unfiltered stream.

Return type:: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___SubscriptionFilter]

class SubscribeResponse(*, event=..., querySerial=..., queryInfo=..., config=...)[source]¶

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

Parameters:

event (Global___SubscriptionEvent)
querySerial (int)
queryInfo (deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryInfoMessage | None)
config (Global___ControllerConfigurationMessage | None)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

CONFIG_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EVENT_FIELD_NUMBER: int[source]¶

QUERYINFO_FIELD_NUMBER: int[source]¶

QUERYSERIAL_FIELD_NUMBER: int[source]¶

property config: Global___ControllerConfigurationMessage[source]¶

Only populated for SE_CONFIG_UPDATE

Return type:: Global___ControllerConfigurationMessage

event: Global___SubscriptionEvent[source]¶

property queryInfo: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryInfoMessage[source]¶

Only populated for SE_PUT, or optionally for SE_BATCH_END

Return type:: deephaven_enterprise.proto.persistent_query_pb2.PersistentQueryInfoMessage

querySerial: int[source]¶: Only populated for SE_REMOVE

class SubscriptionEvent[source]¶: Bases: _SubscriptionEvent

class SubscriptionFilter(*, serial=..., ownerAndName=...)[source]¶

Bases: google.protobuf.message.Message

A single subscription filter element matching a Persistent Query (PQ) either by its serial, or by the combination of its owner and name.

Exactly one of the variants below must be set. A filter element with neither variant set, or with an OwnerAndName where either field is empty, is malformed; servers that honor filters MUST reject such a request with INVALID_ARGUMENT.

Parameters:

serial (int)
ownerAndName (Global___SubscriptionFilter | None)

class OwnerAndName(*, owner=..., name=...)[source]¶

Bases: google.protobuf.message.Message

The (owner, name) pair identifying a PQ. Both fields are required and must be non-empty; specifying only one is malformed.

Parameters:

owner (str)
name (str)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

NAME_FIELD_NUMBER: int[source]¶

OWNER_FIELD_NUMBER: int[source]¶

name: str[source]¶

owner: str[source]¶

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

HasField(field_name)[source]¶

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group)[source]¶

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

OWNERANDNAME_FIELD_NUMBER: int[source]¶

SERIAL_FIELD_NUMBER: int[source]¶

property ownerAndName: Global___SubscriptionFilter[source]¶

Match the PQ whose (owner, name) equals this pair.

Return type:: Global___SubscriptionFilter

serial: int[source]¶: Match the PQ whose serial equals this value.

class WorkerKind(*, name=..., description=..., title=..., worker_control_types=..., implemented_protocols=..., ephemeral_venv_default=...)[source]¶

Bases: google.protobuf.message.Message

A WorkerKind is displayed as an “Engine” in the UI, and defines either the Legacy worker or version of Core+ with associated configuration (e.g., extra packages; properties, etc.).

Parameters:

name (str)
description (str)
title (str)
worker_control_types (collections.abc.Iterable[str] | None)
implemented_protocols (collections.abc.Iterable[Global___WorkerProtocol] | None)
ephemeral_venv_default (bool)

ClearField(field_name)[source]¶

Clears the contents of a given field.

Inside a oneof group, clears the field set. If the name neither refers to a defined field or oneof group, ValueError is raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Raises:: ValueError – if the field_name is not a member of this message.
Return type:: None

DESCRIPTION_FIELD_NUMBER: int[source]¶

DESCRIPTOR: google.protobuf.descriptor.Descriptor[source]¶

EPHEMERAL_VENV_DEFAULT_FIELD_NUMBER: int[source]¶

IMPLEMENTED_PROTOCOLS_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

TITLE_FIELD_NUMBER: int[source]¶

WORKER_CONTROL_TYPES_FIELD_NUMBER: int[source]¶

description: str[source]¶

ephemeral_venv_default: bool[source]¶: Should this worker kind create an ephemeral Python virtual environment by default.

property implemented_protocols: google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___WorkerProtocol][source]¶

The protocols implemented by this worker kind

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[Global___WorkerProtocol]

name: str[source]¶: The name of the worker kind used in persistent query configurations

title: str[source]¶: The title used for drop-down selections in the UI

property worker_control_types: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str][source]¶

What kind of worker control types are supported by this worker kind (e.g., local process or kubernetes)

Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class WorkerProtocol[source]¶: Bases: _WorkerProtocol

DESCRIPTOR: google.protobuf.descriptor.FileDescriptor[source]¶

type Global___AddQueryRequest = AddQueryRequest[source]¶

type Global___AddQueryResponse = AddQueryResponse[source]¶

type Global___AssignmentPolicyConfigMessage = AssignmentPolicyConfigMessage[source]¶

type Global___AuthenticationRequest = AuthenticationRequest[source]¶

type Global___AuthenticationResponse = AuthenticationResponse[source]¶

type Global___ConsoleConfigurationTypeMessage = ConsoleConfigurationTypeMessage[source]¶

type Global___ControllerConfigurationMessage = ControllerConfigurationMessage[source]¶

type Global___ControllerTempQueueDetailsMessage = ControllerTempQueueDetailsMessage[source]¶

type Global___DeserializeQueryConfigurationRequest = DeserializeQueryConfigurationRequest[source]¶

type Global___DeserializeQueryConfigurationResponse = DeserializeQueryConfigurationResponse[source]¶

type Global___DetermineDispatcherRequest = DetermineDispatcherRequest[source]¶

type Global___DetermineDispatcherResponse = DetermineDispatcherResponse[source]¶

type Global___ExtraColumnMessage = ExtraColumnMessage[source]¶

type Global___GetConfigurationRequest = GetConfigurationRequest[source]¶

type Global___GetConfigurationResponse = GetConfigurationResponse[source]¶

type Global___GetScriptPathsRequest = GetScriptPathsRequest[source]¶

type Global___GetScriptPathsResponse = GetScriptPathsResponse[source]¶

type Global___GetScriptRequest = GetScriptRequest[source]¶

type Global___GetScriptResponse = GetScriptResponse[source]¶

type Global___ModifyQueryRequest = ModifyQueryRequest[source]¶

type Global___ModifyQueryResponse = ModifyQueryResponse[source]¶

type Global___PQDBServerConfigMessage = PQDBServerConfigMessage[source]¶

type Global___ReloadConfigRequest = ReloadConfigRequest[source]¶

type Global___ReloadConfigResponse = ReloadConfigResponse[source]¶

type Global___RemoveQueryRequest = RemoveQueryRequest[source]¶

type Global___RemoveQueryResponse = RemoveQueryResponse[source]¶

type Global___ReplicaSpecifier = ReplicaSpecifier[source]¶

type Global___ReplicaStatus = ReplicaStatus[source]¶

type Global___RestartQueryRequest = RestartQueryRequest[source]¶

type Global___RestartQueryResponse = RestartQueryResponse[source]¶

type Global___RestartReplicaRequest = RestartReplicaRequest[source]¶

type Global___RestartReplicaResponse = RestartReplicaResponse[source]¶

type Global___RoutingConfigMessage = RoutingConfigMessage[source]¶

type Global___ScriptCommandEnum = ScriptCommandEnum[source]¶

type Global___SerializeQueryConfigurationRequest = SerializeQueryConfigurationRequest[source]¶

type Global___SerializeQueryConfigurationResponse = SerializeQueryConfigurationResponse[source]¶

type Global___ServerSelectionAdminRequest = ServerSelectionAdminRequest[source]¶

type Global___ServerSelectionAdminResponse = ServerSelectionAdminResponse[source]¶

type Global___ServerSelectionStatusRequest = ServerSelectionStatusRequest[source]¶

type Global___ServerSelectionStatusResponse = ServerSelectionStatusResponse[source]¶

type Global___ServerTypeEnum = ServerTypeEnum[source]¶

type Global___StatusUpdateRequest = StatusUpdateRequest[source]¶

type Global___StatusUpdateResponse = StatusUpdateResponse[source]¶

type Global___StopQueryRequest = StopQueryRequest[source]¶

type Global___StopQueryResponse = StopQueryResponse[source]¶

type Global___StopReplicaRequest = StopReplicaRequest[source]¶

type Global___StopReplicaResponse = StopReplicaResponse[source]¶

type Global___SubscribeRequest = SubscribeRequest[source]¶

type Global___SubscribeResponse = SubscribeResponse[source]¶

type Global___SubscriptionEvent = SubscriptionEvent[source]¶

type Global___SubscriptionFilter = SubscriptionFilter[source]¶

type Global___WorkerKind = WorkerKind[source]¶

type Global___WorkerProtocol = WorkerProtocol[source]¶

SCE_GET_AS_OTHER: ScriptCommandEnum[source]¶

SCE_GET_AS_SELF: ScriptCommandEnum[source]¶

SCE_GET_FOR_QUERY: ScriptCommandEnum[source]¶

SCE_UNSPECIFIED: ScriptCommandEnum[source]¶

SE_BATCH_END: SubscriptionEvent[source]¶: Marks the end of the initial batch of events after subscription, may or may not include a queryInfo value; otherwise equivalent to SE_PUT

SE_CONFIG_UPDATE: SubscriptionEvent[source]¶: Configuration for the controller was updated

SE_PUT: SubscriptionEvent[source]¶: New query was added, or existing query was updated with the same serial

SE_REMOVE: SubscriptionEvent[source]¶: An existing query was removed

SE_UNSPECIFIED: SubscriptionEvent[source]¶

STE_DISPATCHER: ServerTypeEnum[source]¶

STE_GROUP: ServerTypeEnum[source]¶

STE_UNSPECIFIED: ServerTypeEnum[source]¶

WP_COMMUNITY: WorkerProtocol[source]¶: The Community Core gRPC protocol

WP_ENTERPRISE_COMM: WorkerProtocol[source]¶: The enterprise “Comm” Java-serialization based protocol used by Swing and other Java Client Processes

WP_ENTERPRISE_WEBSOCKET: WorkerProtocol[source]¶: The GWT-RPC based web socket protocol for the web UI

WP_UNSPECIFIED: WorkerProtocol[source]¶