deephaven_enterprise.proto.persistent_query_pb2¶

Module Contents¶

class ExportedObjectInfoMessage(*, name=..., type=..., tableDefinition=..., originalType=...)[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)
type (Global___ExportedObjectTypeEnum)
tableDefinition (deephaven_enterprise.proto.table_definition_pb2.TableDefinitionMessage | None)
originalType (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.

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

NAME_FIELD_NUMBER: int[source]¶

ORIGINALTYPE_FIELD_NUMBER: int[source]¶

TABLEDEFINITION_FIELD_NUMBER: int[source]¶

TYPE_FIELD_NUMBER: int[source]¶

name: str[source]¶

originalType: str[source]¶

property tableDefinition: deephaven_enterprise.proto.table_definition_pb2.TableDefinitionMessage[source]¶

Return type:: deephaven_enterprise.proto.table_definition_pb2.TableDefinitionMessage

type: Global___ExportedObjectTypeEnum[source]¶

class ExportedObjectTypeEnum[source]¶: Bases: _ExportedObjectTypeEnum

class PersistentQueryConfigMessage(*, serial=..., version=..., name=..., owner=..., enabled=..., heapSizeGb=..., bufferPoolToHeapRatio=..., detailedGCLoggingEnabled=..., extraJvmArguments=..., extraEnvironmentVariables=..., classPathAdditions=..., serverName=..., adminGroups=..., viewerGroups=..., restartUsers=..., scriptCode=..., scriptPath=..., scriptLanguage=..., configurationType=..., typeSpecificFieldsJson=..., scheduling=..., timeoutNanos=..., jvmProfile=..., lastModifiedByAuthenticated=..., lastModifiedByEffective=..., lastModifiedTimeNanos=..., completedStatus=..., expirationTimeNanos=..., kubernetesControl=..., workerKind=..., createdTimeNanos=..., replicaCount=..., spareCount=..., assignmentPolicy=..., assignmentPolicyParams=..., additionalMemoryGb=..., pythonControl=..., genericWorkerControl=...)[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)
version (int)
name (str)
owner (str)
enabled (bool)
heapSizeGb (float)
bufferPoolToHeapRatio (float)
detailedGCLoggingEnabled (bool)
extraJvmArguments (collections.abc.Iterable[str] | None)
extraEnvironmentVariables (collections.abc.Iterable[str] | None)
classPathAdditions (collections.abc.Iterable[str] | None)
serverName (str)
adminGroups (collections.abc.Iterable[str] | None)
viewerGroups (collections.abc.Iterable[str] | None)
restartUsers (Global___RestartUsersEnum)
scriptCode (str)
scriptPath (str)
scriptLanguage (str)
configurationType (str)
typeSpecificFieldsJson (str | None)
scheduling (collections.abc.Iterable[str] | None)
timeoutNanos (int)
jvmProfile (str)
lastModifiedByAuthenticated (str)
lastModifiedByEffective (str)
lastModifiedTimeNanos (int)
completedStatus (str)
expirationTimeNanos (int)
kubernetesControl (str)
workerKind (str)
createdTimeNanos (int)
replicaCount (int)
spareCount (int)
assignmentPolicy (str)
assignmentPolicyParams (str | None)
additionalMemoryGb (float)
pythonControl (str)
genericWorkerControl (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: Literal['_assignmentPolicyParams', b'_assignmentPolicyParams']) → Literal['assignmentPolicyParams'] | None[source]¶

WhichOneof(oneof_group: Literal['_typeSpecificFieldsJson', b'_typeSpecificFieldsJson']) → Literal['typeSpecificFieldsJson'] | None

WhichOneof(oneof_group: Literal['scriptData', b'scriptData']) → Literal['scriptCode', 'scriptPath'] | 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

ADDITIONALMEMORYGB_FIELD_NUMBER: int[source]¶

ADMINGROUPS_FIELD_NUMBER: int[source]¶

ASSIGNMENTPOLICYPARAMS_FIELD_NUMBER: int[source]¶

ASSIGNMENTPOLICY_FIELD_NUMBER: int[source]¶

BUFFERPOOLTOHEAPRATIO_FIELD_NUMBER: int[source]¶

CLASSPATHADDITIONS_FIELD_NUMBER: int[source]¶

COMPLETEDSTATUS_FIELD_NUMBER: int[source]¶

CONFIGURATIONTYPE_FIELD_NUMBER: int[source]¶

CREATEDTIMENANOS_FIELD_NUMBER: int[source]¶

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

DETAILEDGCLOGGINGENABLED_FIELD_NUMBER: int[source]¶

ENABLED_FIELD_NUMBER: int[source]¶

EXPIRATIONTIMENANOS_FIELD_NUMBER: int[source]¶

EXTRAENVIRONMENTVARIABLES_FIELD_NUMBER: int[source]¶

EXTRAJVMARGUMENTS_FIELD_NUMBER: int[source]¶

GENERICWORKERCONTROL_FIELD_NUMBER: int[source]¶

HEAPSIZEGB_FIELD_NUMBER: int[source]¶

JVMPROFILE_FIELD_NUMBER: int[source]¶

KUBERNETESCONTROL_FIELD_NUMBER: int[source]¶

LASTMODIFIEDBYAUTHENTICATED_FIELD_NUMBER: int[source]¶

LASTMODIFIEDBYEFFECTIVE_FIELD_NUMBER: int[source]¶

LASTMODIFIEDTIMENANOS_FIELD_NUMBER: int[source]¶

NAME_FIELD_NUMBER: int[source]¶

OWNER_FIELD_NUMBER: int[source]¶

PYTHONCONTROL_FIELD_NUMBER: int[source]¶

REPLICACOUNT_FIELD_NUMBER: int[source]¶

RESTARTUSERS_FIELD_NUMBER: int[source]¶

SCHEDULING_FIELD_NUMBER: int[source]¶

SCRIPTCODE_FIELD_NUMBER: int[source]¶

SCRIPTLANGUAGE_FIELD_NUMBER: int[source]¶

SCRIPTPATH_FIELD_NUMBER: int[source]¶

SERIAL_FIELD_NUMBER: int[source]¶

SERVERNAME_FIELD_NUMBER: int[source]¶

SPARECOUNT_FIELD_NUMBER: int[source]¶

TIMEOUTNANOS_FIELD_NUMBER: int[source]¶

TYPESPECIFICFIELDSJSON_FIELD_NUMBER: int[source]¶

VERSION_FIELD_NUMBER: int[source]¶

VIEWERGROUPS_FIELD_NUMBER: int[source]¶

WORKERKIND_FIELD_NUMBER: int[source]¶

additionalMemoryGb: float[source]¶: How much memory beyond the JVM should be allocated to this query?

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

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

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

assignmentPolicy: str[source]¶: The policy the controller should use to assign clients to individual replicas

assignmentPolicyParams: str[source]¶: The policy parameters

bufferPoolToHeapRatio: float[source]¶

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

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.

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

completedStatus: str[source]¶: The status of a temporary query that has entered a terminal state.

configurationType: str[source]¶: What kind of query is this. Typical values are “Script” or “RunAndDone”.

createdTimeNanos: int[source]¶: The query creation time, in nanoseconds since the epoch.

detailedGCLoggingEnabled: bool[source]¶

enabled: bool[source]¶: Is this query enabled? Enabled queries can be executed, disable queries cannot.

expirationTimeNanos: int[source]¶: When this temporary query should be removed, in nanoseconds since the epoch.

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

even-numbered entries contain the environment variable name; odd-numbered entries contain its value.

Type:: Extra environment variables for this query. These must be supplied in pairs
Return type:: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

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

Extra JVM arguments for this query.

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

genericWorkerControl: str[source]¶: Generic worker control JSON

heapSizeGb: float[source]¶: How much heap should be allocated to this query?

jvmProfile: str[source]¶: The jvm profile used by the query.

kubernetesControl: str[source]¶: A JSON string that is used by the dispatcher to customize the worker’s pod when deployed on Kubernetes.

lastModifiedByAuthenticated: str[source]¶: The authenticated user that last modified the configuration.

lastModifiedByEffective: str[source]¶: The effective user that last modified the configuration.

lastModifiedTimeNanos: int[source]¶: The last time the query was modified, in nanoseconds since the epoch.

name: str[source]¶: The name of this persistent query. Currently, the name must be unique to make diagnosing problems easier.

owner: str[source]¶: The owner of the query. The query runs in the user context of the owner.

pythonControl: str[source]¶: Core+ Python virtual environment control

replicaCount: int[source]¶: The number of replicas to create and spread load across

restartUsers: Global___RestartUsersEnum[source]¶: Controls the behavior of who can restart the query (admins, viewers, or viewers when down).

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

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

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

scriptCode: str[source]¶: The text of the query’s startup script.

scriptLanguage: str[source]¶: The query’s script language. Groovy or Python are supported.

scriptPath: str[source]¶: A path to the query’s startup script in the controller’s Git repository.

serial: int[source]¶: 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.

serverName: str[source]¶: 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.

spareCount: int[source]¶: The number of spare workers to create and use as spares to replace failed replicas

timeoutNanos: int[source]¶: How many nanoseconds to allow the query to initialize (or execute for batch queries).

typeSpecificFieldsJson: str[source]¶: JSON representing the fields for this configuration type. The content of this field is dependent on configurationType.

version: int[source]¶: The modification version of this persistent query, which increases by one each time the configuration is modified.

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

Groups that may view the query.

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

workerKind: str[source]¶: What kind of worker is this. Default values are “DeephavenEnterprise” for Legacy workers or “DeephavenCommunity” for Core+ workers, but this can be customized.

class PersistentQueryInfoMessage(*, config=..., state=..., replicas=..., spares=..., is_admin=...)[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___PersistentQueryConfigMessage | None)
state (Global___PersistentQueryStateMessage | None)
replicas (collections.abc.Iterable[Global___PersistentQueryStateMessage] | None)
spares (collections.abc.Iterable[Global___PersistentQueryStateMessage] | None)
is_admin (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

CONFIG_FIELD_NUMBER: int[source]¶

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

IS_ADMIN_FIELD_NUMBER: int[source]¶

REPLICAS_FIELD_NUMBER: int[source]¶

SPARES_FIELD_NUMBER: int[source]¶

STATE_FIELD_NUMBER: int[source]¶

property config: Global___PersistentQueryConfigMessage[source]¶

Return type:: Global___PersistentQueryConfigMessage

is_admin: bool[source]¶: True if current user authorized to administer this query

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

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

property spares: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___PersistentQueryStateMessage][source]¶

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

property state: Global___PersistentQueryStateMessage[source]¶

Return type:: Global___PersistentQueryStateMessage

class PersistentQueryStateMessage(*, serial=..., version=..., status=..., initializationStartNanos=..., initializationCompleteNanos=..., lastUpdateNanos=..., dispatcherHost=..., tableGroups=..., scopeTypes=..., connectionDetails=..., exceptionDetails=..., typeSpecificStateJson=..., lastAuthenticatedUser=..., lastEffectiveUser=..., scriptLoaderStateJson=..., hasProgress=..., progressValue=..., progressMessage=..., engineVersion=..., dispatcherPort=..., shouldStopNanos=..., numFailures=..., lastFailureTimeNanos=..., replicaSlot=..., statusDetails=...)[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)
version (int)
status (Global___PersistentQueryStatusEnum)
initializationStartNanos (int)
initializationCompleteNanos (int)
lastUpdateNanos (int)
dispatcherHost (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 (str)
lastAuthenticatedUser (str)
lastEffectiveUser (str)
scriptLoaderStateJson (str | None)
hasProgress (bool)
progressValue (int)
progressMessage (str)
engineVersion (str)
dispatcherPort (int)
shouldStopNanos (int)
numFailures (int)
lastFailureTimeNanos (int)
replicaSlot (int)
statusDetails (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: Literal['_connectionDetails', b'_connectionDetails']) → Literal['connectionDetails'] | None[source]¶

WhichOneof(oneof_group: Literal['_exceptionDetails', b'_exceptionDetails']) → Literal['exceptionDetails'] | 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

CONNECTIONDETAILS_FIELD_NUMBER: int[source]¶

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

DISPATCHERHOST_FIELD_NUMBER: int[source]¶

DISPATCHERPORT_FIELD_NUMBER: int[source]¶

ENGINEVERSION_FIELD_NUMBER: int[source]¶

EXCEPTIONDETAILS_FIELD_NUMBER: int[source]¶

HASPROGRESS_FIELD_NUMBER: int[source]¶

INITIALIZATIONCOMPLETENANOS_FIELD_NUMBER: int[source]¶

INITIALIZATIONSTARTNANOS_FIELD_NUMBER: int[source]¶

LASTAUTHENTICATEDUSER_FIELD_NUMBER: int[source]¶

LASTEFFECTIVEUSER_FIELD_NUMBER: int[source]¶

LASTFAILURETIMENANOS_FIELD_NUMBER: int[source]¶

LASTUPDATENANOS_FIELD_NUMBER: int[source]¶

NUMFAILURES_FIELD_NUMBER: int[source]¶

PROGRESSMESSAGE_FIELD_NUMBER: int[source]¶

PROGRESSVALUE_FIELD_NUMBER: int[source]¶

REPLICASLOT_FIELD_NUMBER: int[source]¶

SCOPETYPES_FIELD_NUMBER: int[source]¶

SCRIPTLOADERSTATEJSON_FIELD_NUMBER: int[source]¶

SERIAL_FIELD_NUMBER: int[source]¶

SHOULDSTOPNANOS_FIELD_NUMBER: int[source]¶

STATUSDETAILS_FIELD_NUMBER: int[source]¶

STATUS_FIELD_NUMBER: int[source]¶

TABLEGROUPS_FIELD_NUMBER: int[source]¶

TYPESPECIFICSTATEJSON_FIELD_NUMBER: int[source]¶

VERSION_FIELD_NUMBER: int[source]¶

property connectionDetails: Global___ProcessorConnectionDetailsMessage[source]¶

Return type:: Global___ProcessorConnectionDetailsMessage

dispatcherHost: str[source]¶

dispatcherPort: int[source]¶

engineVersion: str[source]¶

property exceptionDetails: deephaven_enterprise.proto.common_pb2.ExceptionDetailsMessage[source]¶

Return type:: deephaven_enterprise.proto.common_pb2.ExceptionDetailsMessage

hasProgress: bool[source]¶

initializationCompleteNanos: int[source]¶: The time in nanoseconds since the epoch when initialization completed. Zero if not completed.

initializationStartNanos: int[source]¶: The time in nanoseconds since the epoch when initialization started. Zero if not started.

lastAuthenticatedUser: str[source]¶

lastEffectiveUser: str[source]¶

lastFailureTimeNanos: int[source]¶

lastUpdateNanos: int[source]¶: The time in nanoseconds since the epoch when the state was last updated. Zero if never updated.

numFailures: int[source]¶

progressMessage: str[source]¶

progressValue: int[source]¶

replicaSlot: int[source]¶

property scopeTypes: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___ExportedObjectInfoMessage][source]¶

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

scriptLoaderStateJson: str[source]¶: Encoded JSON

serial: int[source]¶: The serial number of the query configuration this state corresponds to.

shouldStopNanos: int[source]¶

status: Global___PersistentQueryStatusEnum[source]¶

statusDetails: str[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]

typeSpecificStateJson: str[source]¶: Encoded JSON

version: int[source]¶

class PersistentQueryStatusEnum[source]¶: Bases: _PersistentQueryStatusEnum

class ProcessorConnectionDetailsMessage(*, protocols=..., workerName=..., processInfoId=..., processorHost=..., envoyPrefix=..., grpcUrl=..., staticUrl=..., enterpriseWebSocketUrl=...)[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:

protocols (collections.abc.Iterable[Global___WorkerProtocolMessage] | None)
workerName (str)
processInfoId (str)
processorHost (str)
envoyPrefix (str)
grpcUrl (str)
staticUrl (str)
enterpriseWebSocketUrl (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]¶

ENTERPRISEWEBSOCKETURL_FIELD_NUMBER: int[source]¶

ENVOYPREFIX_FIELD_NUMBER: int[source]¶

GRPCURL_FIELD_NUMBER: int[source]¶

PROCESSINFOID_FIELD_NUMBER: int[source]¶

PROCESSORHOST_FIELD_NUMBER: int[source]¶

PROTOCOLS_FIELD_NUMBER: int[source]¶

STATICURL_FIELD_NUMBER: int[source]¶

WORKERNAME_FIELD_NUMBER: int[source]¶

enterpriseWebSocketUrl: str[source]¶

envoyPrefix: str[source]¶: The envoy prefix/header to use when connecting to the worker, if any. Empty if unused.

grpcUrl: str[source]¶

processInfoId: str[source]¶

processorHost: str[source]¶

property protocols: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___WorkerProtocolMessage][source]¶

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

staticUrl: str[source]¶

workerName: str[source]¶

class RestartUsersEnum[source]¶

Bases: _RestartUsersEnum

Deephaven data types

class WorkerProtocolMessage(*, name=..., port=...)[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)
port (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