"""
@generated by mypy-protobuf. Do not edit manually!
isort:skip_file
Copyright (c) 2016-2022 Deephaven Data Labs and Patent Pending
"""
import builtins
import collections.abc
import deephaven_enterprise.proto.common_pb2
import deephaven_enterprise.proto.controller_common_pb2
import deephaven_enterprise.proto.table_definition_pb2
import google.protobuf.descriptor
import google.protobuf.internal.containers
import google.protobuf.internal.enum_type_wrapper
import google.protobuf.message
import sys
import typing
if sys.version_info >= (3, 10):
import typing as typing_extensions
else:
import typing_extensions
[docs]
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class _RestartUsersEnum:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _RestartUsersEnumEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_RestartUsersEnum.ValueType], builtins.type):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
RU_UNSPECIFIED: _RestartUsersEnum.ValueType # 0
RU_ADMIN: _RestartUsersEnum.ValueType # 1
RU_ADMIN_AND_VIEWERS: _RestartUsersEnum.ValueType # 2
RU_RESERVED_1: _RestartUsersEnum.ValueType # 3
RU_VIEWERS_WHEN_DOWN: _RestartUsersEnum.ValueType # 4
[docs]
class RestartUsersEnum(_RestartUsersEnum, metaclass=_RestartUsersEnumEnumTypeWrapper):
"""Deephaven data types"""
[docs]
RU_UNSPECIFIED: RestartUsersEnum.ValueType # 0
[docs]
RU_ADMIN: RestartUsersEnum.ValueType # 1
[docs]
RU_ADMIN_AND_VIEWERS: RestartUsersEnum.ValueType # 2
[docs]
RU_RESERVED_1: RestartUsersEnum.ValueType # 3
[docs]
RU_VIEWERS_WHEN_DOWN: RestartUsersEnum.ValueType # 4
[docs]
Global___RestartUsersEnum: typing_extensions.TypeAlias = RestartUsersEnum
class _PersistentQueryStatusEnum:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _PersistentQueryStatusEnumEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_PersistentQueryStatusEnum.ValueType], builtins.type):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
PQS_UNSPECIFIED: _PersistentQueryStatusEnum.ValueType # 0
PQS_UNINITIALIZED: _PersistentQueryStatusEnum.ValueType # 1
PQS_CONNECTING: _PersistentQueryStatusEnum.ValueType # 2
PQS_AUTHENTICATING: _PersistentQueryStatusEnum.ValueType # 3
PQS_ACQUIRING_WORKER: _PersistentQueryStatusEnum.ValueType # 4
PQS_INITIALIZING: _PersistentQueryStatusEnum.ValueType # 5
PQS_RUNNING: _PersistentQueryStatusEnum.ValueType # 6
PQS_FAILED: _PersistentQueryStatusEnum.ValueType # 7
PQS_ERROR: _PersistentQueryStatusEnum.ValueType # 8
PQS_DISCONNECTED: _PersistentQueryStatusEnum.ValueType # 9
PQS_STOPPING: _PersistentQueryStatusEnum.ValueType # 10
PQS_STOPPED: _PersistentQueryStatusEnum.ValueType # 11
PQS_COMPLETED: _PersistentQueryStatusEnum.ValueType # 12
PQS_EXECUTING: _PersistentQueryStatusEnum.ValueType # 13
PQS_FINDING_DISPATCHER: _PersistentQueryStatusEnum.ValueType # 14
"""This state is not used."""
[docs]
class PersistentQueryStatusEnum(_PersistentQueryStatusEnum, metaclass=_PersistentQueryStatusEnumEnumTypeWrapper): ...
[docs]
PQS_UNSPECIFIED: PersistentQueryStatusEnum.ValueType # 0
[docs]
PQS_UNINITIALIZED: PersistentQueryStatusEnum.ValueType # 1
[docs]
PQS_CONNECTING: PersistentQueryStatusEnum.ValueType # 2
[docs]
PQS_AUTHENTICATING: PersistentQueryStatusEnum.ValueType # 3
[docs]
PQS_ACQUIRING_WORKER: PersistentQueryStatusEnum.ValueType # 4
[docs]
PQS_INITIALIZING: PersistentQueryStatusEnum.ValueType # 5
[docs]
PQS_RUNNING: PersistentQueryStatusEnum.ValueType # 6
[docs]
PQS_FAILED: PersistentQueryStatusEnum.ValueType # 7
[docs]
PQS_ERROR: PersistentQueryStatusEnum.ValueType # 8
[docs]
PQS_DISCONNECTED: PersistentQueryStatusEnum.ValueType # 9
[docs]
PQS_STOPPING: PersistentQueryStatusEnum.ValueType # 10
[docs]
PQS_STOPPED: PersistentQueryStatusEnum.ValueType # 11
[docs]
PQS_COMPLETED: PersistentQueryStatusEnum.ValueType # 12
[docs]
PQS_EXECUTING: PersistentQueryStatusEnum.ValueType # 13
[docs]
PQS_FINDING_DISPATCHER: PersistentQueryStatusEnum.ValueType # 14
"""This state is not used."""
[docs]
Global___PersistentQueryStatusEnum: typing_extensions.TypeAlias = PersistentQueryStatusEnum
class _ExportedObjectTypeEnum:
ValueType = typing.NewType("ValueType", builtins.int)
V: typing_extensions.TypeAlias = ValueType
class _ExportedObjectTypeEnumEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_ExportedObjectTypeEnum.ValueType], builtins.type):
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
EOT_UNSPECIFIED: _ExportedObjectTypeEnum.ValueType # 0
EOT_TABLE: _ExportedObjectTypeEnum.ValueType # 1
EOT_TREE_TABLE: _ExportedObjectTypeEnum.ValueType # 2
EOT_TABLE_MAP: _ExportedObjectTypeEnum.ValueType # 3
EOT_FIGURE: _ExportedObjectTypeEnum.ValueType # 4
EOT_OTHER_WIDGET: _ExportedObjectTypeEnum.ValueType # 5
EOT_PARAMETERIZED_QUERY: _ExportedObjectTypeEnum.ValueType # 6
EOT_PANDAS: _ExportedObjectTypeEnum.ValueType # 7
EOT_NON_DISPLAYABLE: _ExportedObjectTypeEnum.ValueType # 8
EOT_HIERARCHICAL_TABLE: _ExportedObjectTypeEnum.ValueType # 9
EOT_PARTITIONED_TABLE: _ExportedObjectTypeEnum.ValueType # 10
[docs]
class ExportedObjectTypeEnum(_ExportedObjectTypeEnum, metaclass=_ExportedObjectTypeEnumEnumTypeWrapper): ...
[docs]
EOT_UNSPECIFIED: ExportedObjectTypeEnum.ValueType # 0
[docs]
EOT_TABLE: ExportedObjectTypeEnum.ValueType # 1
[docs]
EOT_TREE_TABLE: ExportedObjectTypeEnum.ValueType # 2
[docs]
EOT_TABLE_MAP: ExportedObjectTypeEnum.ValueType # 3
[docs]
EOT_PARAMETERIZED_QUERY: ExportedObjectTypeEnum.ValueType # 6
[docs]
EOT_PANDAS: ExportedObjectTypeEnum.ValueType # 7
[docs]
EOT_NON_DISPLAYABLE: ExportedObjectTypeEnum.ValueType # 8
[docs]
EOT_HIERARCHICAL_TABLE: ExportedObjectTypeEnum.ValueType # 9
[docs]
EOT_PARTITIONED_TABLE: ExportedObjectTypeEnum.ValueType # 10
[docs]
Global___ExportedObjectTypeEnum: typing_extensions.TypeAlias = ExportedObjectTypeEnum
@typing.final
[docs]
class PersistentQueryConfigMessage(google.protobuf.message.Message):
[docs]
DESCRIPTOR: google.protobuf.descriptor.Descriptor
[docs]
SERIAL_FIELD_NUMBER: builtins.int
[docs]
VERSION_FIELD_NUMBER: builtins.int
[docs]
NAME_FIELD_NUMBER: builtins.int
[docs]
OWNER_FIELD_NUMBER: builtins.int
[docs]
ENABLED_FIELD_NUMBER: builtins.int
[docs]
HEAPSIZEGB_FIELD_NUMBER: builtins.int
[docs]
BUFFERPOOLTOHEAPRATIO_FIELD_NUMBER: builtins.int
[docs]
DETAILEDGCLOGGINGENABLED_FIELD_NUMBER: builtins.int
[docs]
CLASSPATHADDITIONS_FIELD_NUMBER: builtins.int
[docs]
SERVERNAME_FIELD_NUMBER: builtins.int
[docs]
ADMINGROUPS_FIELD_NUMBER: builtins.int
[docs]
VIEWERGROUPS_FIELD_NUMBER: builtins.int
[docs]
RESTARTUSERS_FIELD_NUMBER: builtins.int
[docs]
SCRIPTCODE_FIELD_NUMBER: builtins.int
[docs]
SCRIPTPATH_FIELD_NUMBER: builtins.int
[docs]
SCRIPTLANGUAGE_FIELD_NUMBER: builtins.int
[docs]
CONFIGURATIONTYPE_FIELD_NUMBER: builtins.int
[docs]
TYPESPECIFICFIELDSJSON_FIELD_NUMBER: builtins.int
[docs]
SCHEDULING_FIELD_NUMBER: builtins.int
[docs]
TIMEOUTNANOS_FIELD_NUMBER: builtins.int
[docs]
JVMPROFILE_FIELD_NUMBER: builtins.int
[docs]
LASTMODIFIEDBYAUTHENTICATED_FIELD_NUMBER: builtins.int
[docs]
LASTMODIFIEDBYEFFECTIVE_FIELD_NUMBER: builtins.int
[docs]
LASTMODIFIEDTIMENANOS_FIELD_NUMBER: builtins.int
[docs]
COMPLETEDSTATUS_FIELD_NUMBER: builtins.int
[docs]
EXPIRATIONTIMENANOS_FIELD_NUMBER: builtins.int
[docs]
KUBERNETESCONTROL_FIELD_NUMBER: builtins.int
[docs]
WORKERKIND_FIELD_NUMBER: builtins.int
[docs]
CREATEDTIMENANOS_FIELD_NUMBER: builtins.int
[docs]
REPLICACOUNT_FIELD_NUMBER: builtins.int
[docs]
SPARECOUNT_FIELD_NUMBER: builtins.int
[docs]
ASSIGNMENTPOLICY_FIELD_NUMBER: builtins.int
[docs]
ASSIGNMENTPOLICYPARAMS_FIELD_NUMBER: builtins.int
[docs]
ADDITIONALMEMORYGB_FIELD_NUMBER: builtins.int
[docs]
PYTHONCONTROL_FIELD_NUMBER: builtins.int
[docs]
GENERICWORKERCONTROL_FIELD_NUMBER: builtins.int
"""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.
"""
"""The modification version of this persistent query, which increases by one each time the configuration is modified."""
"""The name of this persistent query. Currently, the name must be unique to make diagnosing problems easier."""
"""The owner of the query. The query runs in the user context of the owner."""
"""Is this query enabled? Enabled queries can be executed, disable queries cannot."""
[docs]
heapSizeGb: builtins.float
"""How much heap should be allocated to this query?"""
[docs]
bufferPoolToHeapRatio: builtins.float
[docs]
detailedGCLoggingEnabled: builtins.bool
[docs]
serverName: builtins.str
"""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.
"""
[docs]
restartUsers: Global___RestartUsersEnum.ValueType
"""Controls the behavior of who can restart the query (admins, viewers, or viewers when down)."""
[docs]
scriptCode: builtins.str
"""The text of the query's startup script."""
[docs]
scriptPath: builtins.str
"""A path to the query's startup script in the controller's Git repository."""
[docs]
scriptLanguage: builtins.str
"""The query's script language. Groovy or Python are supported."""
[docs]
configurationType: builtins.str
"""What kind of query is this. Typical values are "Script" or "RunAndDone"."""
[docs]
typeSpecificFieldsJson: builtins.str
"""JSON representing the fields for this configuration type. The content of this field is dependent on configurationType."""
[docs]
timeoutNanos: builtins.int
"""How many nanoseconds to allow the query to initialize (or execute for batch queries)."""
[docs]
jvmProfile: builtins.str
"""The jvm profile used by the query."""
[docs]
lastModifiedByAuthenticated: builtins.str
"""The authenticated user that last modified the configuration."""
[docs]
lastModifiedByEffective: builtins.str
"""The effective user that last modified the configuration."""
[docs]
lastModifiedTimeNanos: builtins.int
"""The last time the query was modified, in nanoseconds since the epoch."""
[docs]
completedStatus: builtins.str
"""The status of a temporary query that has entered a terminal state."""
[docs]
expirationTimeNanos: builtins.int
"""When this temporary query should be removed, in nanoseconds since the epoch."""
[docs]
kubernetesControl: builtins.str
"""A JSON string that is used by the dispatcher to customize the worker’s pod when deployed on Kubernetes."""
[docs]
workerKind: builtins.str
"""What kind of worker is this. Default values are "DeephavenEnterprise" for Legacy workers or "DeephavenCommunity"
for Core+ workers, but this can be customized.
"""
[docs]
createdTimeNanos: builtins.int
"""The query creation time, in nanoseconds since the epoch."""
[docs]
replicaCount: builtins.int
"""The number of replicas to create and spread load across"""
[docs]
spareCount: builtins.int
"""The number of spare workers to create and use as spares to replace failed replicas"""
[docs]
assignmentPolicy: builtins.str
"""The policy the controller should use to assign clients to individual replicas"""
[docs]
assignmentPolicyParams: builtins.str
"""The policy parameters"""
[docs]
additionalMemoryGb: builtins.float
"""How much memory beyond the JVM should be allocated to this query?"""
[docs]
pythonControl: builtins.str
"""Core+ Python virtual environment control"""
[docs]
genericWorkerControl: builtins.str
"""Generic worker control JSON"""
@property
@property
@property
[docs]
def classPathAdditions(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""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.
"""
@property
[docs]
def adminGroups(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""Groups that may administer the query. Administrators may change the query configuration, stop and start it, and
view tables without ACL application.
"""
@property
[docs]
def viewerGroups(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""Groups that may view the query."""
@property
[docs]
def scheduling(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
"""An array of Strings that define when the query starts and stops."""
def __init__(
self,
*,
serial: builtins.int = ...,
version: builtins.int = ...,
name: builtins.str = ...,
owner: builtins.str = ...,
enabled: builtins.bool = ...,
heapSizeGb: builtins.float = ...,
bufferPoolToHeapRatio: builtins.float = ...,
detailedGCLoggingEnabled: builtins.bool = ...,
extraJvmArguments: collections.abc.Iterable[builtins.str] | None = ...,
extraEnvironmentVariables: collections.abc.Iterable[builtins.str] | None = ...,
classPathAdditions: collections.abc.Iterable[builtins.str] | None = ...,
serverName: builtins.str = ...,
adminGroups: collections.abc.Iterable[builtins.str] | None = ...,
viewerGroups: collections.abc.Iterable[builtins.str] | None = ...,
restartUsers: Global___RestartUsersEnum.ValueType = ...,
scriptCode: builtins.str = ...,
scriptPath: builtins.str = ...,
scriptLanguage: builtins.str = ...,
configurationType: builtins.str = ...,
typeSpecificFieldsJson: builtins.str | None = ...,
scheduling: collections.abc.Iterable[builtins.str] | None = ...,
timeoutNanos: builtins.int = ...,
jvmProfile: builtins.str = ...,
lastModifiedByAuthenticated: builtins.str = ...,
lastModifiedByEffective: builtins.str = ...,
lastModifiedTimeNanos: builtins.int = ...,
completedStatus: builtins.str = ...,
expirationTimeNanos: builtins.int = ...,
kubernetesControl: builtins.str = ...,
workerKind: builtins.str = ...,
createdTimeNanos: builtins.int = ...,
replicaCount: builtins.int = ...,
spareCount: builtins.int = ...,
assignmentPolicy: builtins.str = ...,
assignmentPolicyParams: builtins.str | None = ...,
additionalMemoryGb: builtins.float = ...,
pythonControl: builtins.str = ...,
genericWorkerControl: builtins.str = ...,
) -> None: ...
[docs]
def HasField(self, field_name: typing.Literal["_assignmentPolicyParams", b"_assignmentPolicyParams", "_typeSpecificFieldsJson", b"_typeSpecificFieldsJson", "assignmentPolicyParams", b"assignmentPolicyParams", "scriptCode", b"scriptCode", "scriptData", b"scriptData", "scriptPath", b"scriptPath", "typeSpecificFieldsJson", b"typeSpecificFieldsJson"]) -> builtins.bool: ...
[docs]
def ClearField(self, field_name: typing.Literal["_assignmentPolicyParams", b"_assignmentPolicyParams", "_typeSpecificFieldsJson", b"_typeSpecificFieldsJson", "additionalMemoryGb", b"additionalMemoryGb", "adminGroups", b"adminGroups", "assignmentPolicy", b"assignmentPolicy", "assignmentPolicyParams", b"assignmentPolicyParams", "bufferPoolToHeapRatio", b"bufferPoolToHeapRatio", "classPathAdditions", b"classPathAdditions", "completedStatus", b"completedStatus", "configurationType", b"configurationType", "createdTimeNanos", b"createdTimeNanos", "detailedGCLoggingEnabled", b"detailedGCLoggingEnabled", "enabled", b"enabled", "expirationTimeNanos", b"expirationTimeNanos", "extraEnvironmentVariables", b"extraEnvironmentVariables", "extraJvmArguments", b"extraJvmArguments", "genericWorkerControl", b"genericWorkerControl", "heapSizeGb", b"heapSizeGb", "jvmProfile", b"jvmProfile", "kubernetesControl", b"kubernetesControl", "lastModifiedByAuthenticated", b"lastModifiedByAuthenticated", "lastModifiedByEffective", b"lastModifiedByEffective", "lastModifiedTimeNanos", b"lastModifiedTimeNanos", "name", b"name", "owner", b"owner", "pythonControl", b"pythonControl", "replicaCount", b"replicaCount", "restartUsers", b"restartUsers", "scheduling", b"scheduling", "scriptCode", b"scriptCode", "scriptData", b"scriptData", "scriptLanguage", b"scriptLanguage", "scriptPath", b"scriptPath", "serial", b"serial", "serverName", b"serverName", "spareCount", b"spareCount", "timeoutNanos", b"timeoutNanos", "typeSpecificFieldsJson", b"typeSpecificFieldsJson", "version", b"version", "viewerGroups", b"viewerGroups", "workerKind", b"workerKind"]) -> None: ...
@typing.overload
[docs]
def WhichOneof(self, oneof_group: typing.Literal["_assignmentPolicyParams", b"_assignmentPolicyParams"]) -> typing.Literal["assignmentPolicyParams"] | None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["_typeSpecificFieldsJson", b"_typeSpecificFieldsJson"]) -> typing.Literal["typeSpecificFieldsJson"] | None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["scriptData", b"scriptData"]) -> typing.Literal["scriptCode", "scriptPath"] | None: ...
[docs]
Global___PersistentQueryConfigMessage: typing_extensions.TypeAlias = PersistentQueryConfigMessage
@typing.final
[docs]
class ExportedObjectInfoMessage(google.protobuf.message.Message):
[docs]
DESCRIPTOR: google.protobuf.descriptor.Descriptor
[docs]
NAME_FIELD_NUMBER: builtins.int
[docs]
TYPE_FIELD_NUMBER: builtins.int
[docs]
TABLEDEFINITION_FIELD_NUMBER: builtins.int
[docs]
ORIGINALTYPE_FIELD_NUMBER: builtins.int
[docs]
type: Global___ExportedObjectTypeEnum.ValueType
[docs]
originalType: builtins.str
@property
[docs]
def tableDefinition(self) -> deephaven_enterprise.proto.table_definition_pb2.TableDefinitionMessage: ...
def __init__(
self,
*,
name: builtins.str = ...,
type: Global___ExportedObjectTypeEnum.ValueType = ...,
tableDefinition: deephaven_enterprise.proto.table_definition_pb2.TableDefinitionMessage | None = ...,
originalType: builtins.str = ...,
) -> None: ...
[docs]
def HasField(self, field_name: typing.Literal["tableDefinition", b"tableDefinition"]) -> builtins.bool: ...
[docs]
def ClearField(self, field_name: typing.Literal["name", b"name", "originalType", b"originalType", "tableDefinition", b"tableDefinition", "type", b"type"]) -> None: ...
[docs]
Global___ExportedObjectInfoMessage: typing_extensions.TypeAlias = ExportedObjectInfoMessage
@typing.final
[docs]
class WorkerProtocolMessage(google.protobuf.message.Message):
[docs]
DESCRIPTOR: google.protobuf.descriptor.Descriptor
[docs]
NAME_FIELD_NUMBER: builtins.int
[docs]
PORT_FIELD_NUMBER: builtins.int
def __init__(
self,
*,
name: builtins.str = ...,
port: builtins.int = ...,
) -> None: ...
[docs]
def ClearField(self, field_name: typing.Literal["name", b"name", "port", b"port"]) -> None: ...
[docs]
Global___WorkerProtocolMessage: typing_extensions.TypeAlias = WorkerProtocolMessage
@typing.final
[docs]
class ProcessorConnectionDetailsMessage(google.protobuf.message.Message):
[docs]
DESCRIPTOR: google.protobuf.descriptor.Descriptor
[docs]
PROTOCOLS_FIELD_NUMBER: builtins.int
[docs]
WORKERNAME_FIELD_NUMBER: builtins.int
[docs]
PROCESSINFOID_FIELD_NUMBER: builtins.int
[docs]
PROCESSORHOST_FIELD_NUMBER: builtins.int
[docs]
ENVOYPREFIX_FIELD_NUMBER: builtins.int
[docs]
GRPCURL_FIELD_NUMBER: builtins.int
[docs]
STATICURL_FIELD_NUMBER: builtins.int
[docs]
ENTERPRISEWEBSOCKETURL_FIELD_NUMBER: builtins.int
[docs]
workerName: builtins.str
[docs]
processInfoId: builtins.str
[docs]
processorHost: builtins.str
[docs]
envoyPrefix: builtins.str
"""The envoy prefix/header to use when connecting to the worker, if any. Empty if unused."""
[docs]
staticUrl: builtins.str
[docs]
enterpriseWebSocketUrl: builtins.str
@property
[docs]
def protocols(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___WorkerProtocolMessage]: ...
def __init__(
self,
*,
protocols: collections.abc.Iterable[Global___WorkerProtocolMessage] | None = ...,
workerName: builtins.str = ...,
processInfoId: builtins.str = ...,
processorHost: builtins.str = ...,
envoyPrefix: builtins.str = ...,
grpcUrl: builtins.str = ...,
staticUrl: builtins.str = ...,
enterpriseWebSocketUrl: builtins.str = ...,
) -> None: ...
[docs]
def ClearField(self, field_name: typing.Literal["enterpriseWebSocketUrl", b"enterpriseWebSocketUrl", "envoyPrefix", b"envoyPrefix", "grpcUrl", b"grpcUrl", "processInfoId", b"processInfoId", "processorHost", b"processorHost", "protocols", b"protocols", "staticUrl", b"staticUrl", "workerName", b"workerName"]) -> None: ...
[docs]
Global___ProcessorConnectionDetailsMessage: typing_extensions.TypeAlias = ProcessorConnectionDetailsMessage
@typing.final
[docs]
class PersistentQueryStateMessage(google.protobuf.message.Message):
[docs]
DESCRIPTOR: google.protobuf.descriptor.Descriptor
[docs]
SERIAL_FIELD_NUMBER: builtins.int
[docs]
VERSION_FIELD_NUMBER: builtins.int
[docs]
STATUS_FIELD_NUMBER: builtins.int
[docs]
INITIALIZATIONSTARTNANOS_FIELD_NUMBER: builtins.int
[docs]
INITIALIZATIONCOMPLETENANOS_FIELD_NUMBER: builtins.int
[docs]
LASTUPDATENANOS_FIELD_NUMBER: builtins.int
[docs]
DISPATCHERHOST_FIELD_NUMBER: builtins.int
[docs]
TABLEGROUPS_FIELD_NUMBER: builtins.int
[docs]
SCOPETYPES_FIELD_NUMBER: builtins.int
[docs]
CONNECTIONDETAILS_FIELD_NUMBER: builtins.int
[docs]
EXCEPTIONDETAILS_FIELD_NUMBER: builtins.int
[docs]
TYPESPECIFICSTATEJSON_FIELD_NUMBER: builtins.int
[docs]
LASTAUTHENTICATEDUSER_FIELD_NUMBER: builtins.int
[docs]
LASTEFFECTIVEUSER_FIELD_NUMBER: builtins.int
[docs]
SCRIPTLOADERSTATEJSON_FIELD_NUMBER: builtins.int
[docs]
HASPROGRESS_FIELD_NUMBER: builtins.int
[docs]
PROGRESSVALUE_FIELD_NUMBER: builtins.int
[docs]
PROGRESSMESSAGE_FIELD_NUMBER: builtins.int
[docs]
ENGINEVERSION_FIELD_NUMBER: builtins.int
[docs]
DISPATCHERPORT_FIELD_NUMBER: builtins.int
[docs]
SHOULDSTOPNANOS_FIELD_NUMBER: builtins.int
[docs]
NUMFAILURES_FIELD_NUMBER: builtins.int
[docs]
LASTFAILURETIMENANOS_FIELD_NUMBER: builtins.int
[docs]
REPLICASLOT_FIELD_NUMBER: builtins.int
[docs]
STATUSDETAILS_FIELD_NUMBER: builtins.int
"""The serial number of the query configuration this state corresponds to."""
[docs]
status: Global___PersistentQueryStatusEnum.ValueType
[docs]
initializationStartNanos: builtins.int
"""The time in nanoseconds since the epoch when initialization started. Zero if not started."""
[docs]
initializationCompleteNanos: builtins.int
"""The time in nanoseconds since the epoch when initialization completed. Zero if not completed."""
[docs]
lastUpdateNanos: builtins.int
"""The time in nanoseconds since the epoch when the state was last updated. Zero if never updated."""
[docs]
dispatcherHost: builtins.str
[docs]
typeSpecificStateJson: builtins.str
"""Encoded JSON"""
[docs]
lastAuthenticatedUser: builtins.str
[docs]
lastEffectiveUser: builtins.str
[docs]
scriptLoaderStateJson: builtins.str
"""Encoded JSON"""
[docs]
hasProgress: builtins.bool
[docs]
progressValue: builtins.int
[docs]
progressMessage: builtins.str
[docs]
engineVersion: builtins.str
[docs]
dispatcherPort: builtins.int
[docs]
shouldStopNanos: builtins.int
[docs]
numFailures: builtins.int
[docs]
lastFailureTimeNanos: builtins.int
[docs]
replicaSlot: builtins.int
[docs]
statusDetails: builtins.str
@property
[docs]
def tableGroups(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[deephaven_enterprise.proto.controller_common_pb2.NamedStringList]: ...
@property
[docs]
def scopeTypes(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ExportedObjectInfoMessage]: ...
@property
[docs]
def connectionDetails(self) -> Global___ProcessorConnectionDetailsMessage: ...
@property
[docs]
def exceptionDetails(self) -> deephaven_enterprise.proto.common_pb2.ExceptionDetailsMessage: ...
def __init__(
self,
*,
serial: builtins.int = ...,
version: builtins.int = ...,
status: Global___PersistentQueryStatusEnum.ValueType = ...,
initializationStartNanos: builtins.int = ...,
initializationCompleteNanos: builtins.int = ...,
lastUpdateNanos: builtins.int = ...,
dispatcherHost: builtins.str = ...,
tableGroups: collections.abc.Iterable[deephaven_enterprise.proto.controller_common_pb2.NamedStringList] | None = ...,
scopeTypes: collections.abc.Iterable[Global___ExportedObjectInfoMessage] | None = ...,
connectionDetails: Global___ProcessorConnectionDetailsMessage | None = ...,
exceptionDetails: deephaven_enterprise.proto.common_pb2.ExceptionDetailsMessage | None = ...,
typeSpecificStateJson: builtins.str = ...,
lastAuthenticatedUser: builtins.str = ...,
lastEffectiveUser: builtins.str = ...,
scriptLoaderStateJson: builtins.str | None = ...,
hasProgress: builtins.bool = ...,
progressValue: builtins.int = ...,
progressMessage: builtins.str = ...,
engineVersion: builtins.str = ...,
dispatcherPort: builtins.int = ...,
shouldStopNanos: builtins.int = ...,
numFailures: builtins.int = ...,
lastFailureTimeNanos: builtins.int = ...,
replicaSlot: builtins.int = ...,
statusDetails: builtins.str = ...,
) -> None: ...
[docs]
def HasField(self, field_name: typing.Literal["_connectionDetails", b"_connectionDetails", "_exceptionDetails", b"_exceptionDetails", "_scriptLoaderStateJson", b"_scriptLoaderStateJson", "connectionDetails", b"connectionDetails", "exceptionDetails", b"exceptionDetails", "scriptLoaderStateJson", b"scriptLoaderStateJson"]) -> builtins.bool: ...
[docs]
def ClearField(self, field_name: typing.Literal["_connectionDetails", b"_connectionDetails", "_exceptionDetails", b"_exceptionDetails", "_scriptLoaderStateJson", b"_scriptLoaderStateJson", "connectionDetails", b"connectionDetails", "dispatcherHost", b"dispatcherHost", "dispatcherPort", b"dispatcherPort", "engineVersion", b"engineVersion", "exceptionDetails", b"exceptionDetails", "hasProgress", b"hasProgress", "initializationCompleteNanos", b"initializationCompleteNanos", "initializationStartNanos", b"initializationStartNanos", "lastAuthenticatedUser", b"lastAuthenticatedUser", "lastEffectiveUser", b"lastEffectiveUser", "lastFailureTimeNanos", b"lastFailureTimeNanos", "lastUpdateNanos", b"lastUpdateNanos", "numFailures", b"numFailures", "progressMessage", b"progressMessage", "progressValue", b"progressValue", "replicaSlot", b"replicaSlot", "scopeTypes", b"scopeTypes", "scriptLoaderStateJson", b"scriptLoaderStateJson", "serial", b"serial", "shouldStopNanos", b"shouldStopNanos", "status", b"status", "statusDetails", b"statusDetails", "tableGroups", b"tableGroups", "typeSpecificStateJson", b"typeSpecificStateJson", "version", b"version"]) -> None: ...
@typing.overload
[docs]
def WhichOneof(self, oneof_group: typing.Literal["_connectionDetails", b"_connectionDetails"]) -> typing.Literal["connectionDetails"] | None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["_exceptionDetails", b"_exceptionDetails"]) -> typing.Literal["exceptionDetails"] | None: ...
@typing.overload
def WhichOneof(self, oneof_group: typing.Literal["_scriptLoaderStateJson", b"_scriptLoaderStateJson"]) -> typing.Literal["scriptLoaderStateJson"] | None: ...
[docs]
Global___PersistentQueryStateMessage: typing_extensions.TypeAlias = PersistentQueryStateMessage
@typing.final
[docs]
class PersistentQueryInfoMessage(google.protobuf.message.Message):
[docs]
DESCRIPTOR: google.protobuf.descriptor.Descriptor
[docs]
CONFIG_FIELD_NUMBER: builtins.int
[docs]
STATE_FIELD_NUMBER: builtins.int
[docs]
REPLICAS_FIELD_NUMBER: builtins.int
[docs]
SPARES_FIELD_NUMBER: builtins.int
[docs]
IS_ADMIN_FIELD_NUMBER: builtins.int
[docs]
is_admin: builtins.bool
"""True if current user authorized to administer this query"""
@property
[docs]
def config(self) -> Global___PersistentQueryConfigMessage: ...
@property
[docs]
def state(self) -> Global___PersistentQueryStateMessage: ...
@property
[docs]
def replicas(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___PersistentQueryStateMessage]: ...
@property
[docs]
def spares(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___PersistentQueryStateMessage]: ...
def __init__(
self,
*,
config: Global___PersistentQueryConfigMessage | None = ...,
state: Global___PersistentQueryStateMessage | None = ...,
replicas: collections.abc.Iterable[Global___PersistentQueryStateMessage] | None = ...,
spares: collections.abc.Iterable[Global___PersistentQueryStateMessage] | None = ...,
is_admin: builtins.bool = ...,
) -> None: ...
[docs]
def HasField(self, field_name: typing.Literal["_state", b"_state", "config", b"config", "state", b"state"]) -> builtins.bool: ...
[docs]
def ClearField(self, field_name: typing.Literal["_state", b"_state", "config", b"config", "is_admin", b"is_admin", "replicas", b"replicas", "spares", b"spares", "state", b"state"]) -> None: ...
[docs]
def WhichOneof(self, oneof_group: typing.Literal["_state", b"_state"]) -> typing.Literal["state"] | None: ...
[docs]
Global___PersistentQueryInfoMessage: typing_extensions.TypeAlias = PersistentQueryInfoMessage