Package io.deephaven.proto.controller

Interface PersistentQueryConfigMessageOrBuilder

All Superinterfaces:
io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder, io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PersistentQueryConfigMessage, PersistentQueryConfigMessage.Builder
public interface PersistentQueryConfigMessageOrBuilder extends io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder

  • Method Details

    • getSerial

      long getSerial()
       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.
      int64 serial = 1;
      Returns:
      The serial.

    • getVersion

      long getVersion()
       The modification version of this persistent query, which increases by one each time the configuration is modified.
      int64 version = 2;
      Returns:
      The version.

    • getName

      String getName()
       The name of this persistent query.  Currently, the name must be unique to make diagnosing problems easier.
      string name = 3;
      Returns:
      The name.

    • getNameBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getNameBytes()
       The name of this persistent query.  Currently, the name must be unique to make diagnosing problems easier.
      string name = 3;
      Returns:
      The bytes for name.

    • getOwner

      String getOwner()
       The owner of the query.  The query runs in the user context of the owner.
      string owner = 4;
      Returns:
      The owner.

    • getOwnerBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getOwnerBytes()
       The owner of the query.  The query runs in the user context of the owner.
      string owner = 4;
      Returns:
      The bytes for owner.

    • getEnabled

      boolean getEnabled()
       Is this query enabled?  Enabled queries can be executed, disable queries cannot.
      bool enabled = 5;
      Returns:
      The enabled.

    • getHeapSizeGb

      double getHeapSizeGb()
       How much heap should be allocated to this query?
      double heapSizeGb = 6;
      Returns:
      The heapSizeGb.

    • getBufferPoolToHeapRatio

      double getBufferPoolToHeapRatio()
      double bufferPoolToHeapRatio = 7;
      Returns:
      The bufferPoolToHeapRatio.

    • getDetailedGCLoggingEnabled

      boolean getDetailedGCLoggingEnabled()
      bool detailedGCLoggingEnabled = 8;
      Returns:
      The detailedGCLoggingEnabled.

    • getExtraJvmArgumentsList

      List<String> getExtraJvmArgumentsList()
       Extra JVM arguments for this query.
      repeated string extraJvmArguments = 9;
      Returns:
      A list containing the extraJvmArguments.

    • getExtraJvmArgumentsCount

      int getExtraJvmArgumentsCount()
       Extra JVM arguments for this query.
      repeated string extraJvmArguments = 9;
      Returns:
      The count of extraJvmArguments.

    • getExtraJvmArguments

      String getExtraJvmArguments(int index)
       Extra JVM arguments for this query.
      repeated string extraJvmArguments = 9;
      Parameters:
      index - The index of the element to return.
      Returns:
      The extraJvmArguments at the given index.

    • getExtraJvmArgumentsBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getExtraJvmArgumentsBytes(int index)
       Extra JVM arguments for this query.
      repeated string extraJvmArguments = 9;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the extraJvmArguments at the given index.

    • getExtraEnvironmentVariablesList

      List<String> getExtraEnvironmentVariablesList()
       Extra environment variables for this query.
      repeated string extraEnvironmentVariables = 10;
      Returns:
      A list containing the extraEnvironmentVariables.

    • getExtraEnvironmentVariablesCount

      int getExtraEnvironmentVariablesCount()
       Extra environment variables for this query.
      repeated string extraEnvironmentVariables = 10;
      Returns:
      The count of extraEnvironmentVariables.

    • getExtraEnvironmentVariables

      String getExtraEnvironmentVariables(int index)
       Extra environment variables for this query.
      repeated string extraEnvironmentVariables = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The extraEnvironmentVariables at the given index.

    • getExtraEnvironmentVariablesBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getExtraEnvironmentVariablesBytes(int index)
       Extra environment variables for this query.
      repeated string extraEnvironmentVariables = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the extraEnvironmentVariables at the given index.

    • getClassPathAdditionsList

      List<String> getClassPathAdditionsList()
       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.
      repeated string classPathAdditions = 11;
      Returns:
      A list containing the classPathAdditions.

    • getClassPathAdditionsCount

      int getClassPathAdditionsCount()
       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.
      repeated string classPathAdditions = 11;
      Returns:
      The count of classPathAdditions.

    • getClassPathAdditions

      String getClassPathAdditions(int index)
       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.
      repeated string classPathAdditions = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The classPathAdditions at the given index.

    • getClassPathAdditionsBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getClassPathAdditionsBytes(int index)
       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.
      repeated string classPathAdditions = 11;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the classPathAdditions at the given index.

    • getServerName

      String getServerName()
       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.
      string serverName = 12;
      Returns:
      The serverName.

    • getServerNameBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getServerNameBytes()
       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.
      string serverName = 12;
      Returns:
      The bytes for serverName.

    • getAdminGroupsList

      List<String> getAdminGroupsList()
       Groups that may administer the query.  Administrators may change the query configuration, stop and start it, and
 view tables without ACL application.
      repeated string adminGroups = 13;
      Returns:
      A list containing the adminGroups.

    • getAdminGroupsCount

      int getAdminGroupsCount()
       Groups that may administer the query.  Administrators may change the query configuration, stop and start it, and
 view tables without ACL application.
      repeated string adminGroups = 13;
      Returns:
      The count of adminGroups.

    • getAdminGroups

      String getAdminGroups(int index)
       Groups that may administer the query.  Administrators may change the query configuration, stop and start it, and
 view tables without ACL application.
      repeated string adminGroups = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The adminGroups at the given index.

    • getAdminGroupsBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getAdminGroupsBytes(int index)
       Groups that may administer the query.  Administrators may change the query configuration, stop and start it, and
 view tables without ACL application.
      repeated string adminGroups = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the adminGroups at the given index.

    • getViewerGroupsList

      List<String> getViewerGroupsList()
       Groups that may view the query.
      repeated string viewerGroups = 14;
      Returns:
      A list containing the viewerGroups.

    • getViewerGroupsCount

      int getViewerGroupsCount()
       Groups that may view the query.
      repeated string viewerGroups = 14;
      Returns:
      The count of viewerGroups.

    • getViewerGroups

      String getViewerGroups(int index)
       Groups that may view the query.
      repeated string viewerGroups = 14;
      Parameters:
      index - The index of the element to return.
      Returns:
      The viewerGroups at the given index.

    • getViewerGroupsBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getViewerGroupsBytes(int index)
       Groups that may view the query.
      repeated string viewerGroups = 14;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the viewerGroups at the given index.

    • getRestartUsersValue

      int getRestartUsersValue()
       Controls the behavior of who can restart the query (admins, viewers, or viewers when down).
      .io.deephaven.proto.controller.RestartUsersEnum restartUsers = 15;
      Returns:
      The enum numeric value on the wire for restartUsers.

    • getRestartUsers

      RestartUsersEnum getRestartUsers()
       Controls the behavior of who can restart the query (admins, viewers, or viewers when down).
      .io.deephaven.proto.controller.RestartUsersEnum restartUsers = 15;
      Returns:
      The restartUsers.

    • hasScriptCode

      boolean hasScriptCode()
       The text of the query's startup script.
      string scriptCode = 16;
      Returns:
      Whether the scriptCode field is set.

    • getScriptCode

      String getScriptCode()
       The text of the query's startup script.
      string scriptCode = 16;
      Returns:
      The scriptCode.

    • getScriptCodeBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getScriptCodeBytes()
       The text of the query's startup script.
      string scriptCode = 16;
      Returns:
      The bytes for scriptCode.

    • hasScriptPath

      boolean hasScriptPath()
       A path to the query's startup script in the controller's Git repository.
      string scriptPath = 17;
      Returns:
      Whether the scriptPath field is set.

    • getScriptPath

      String getScriptPath()
       A path to the query's startup script in the controller's Git repository.
      string scriptPath = 17;
      Returns:
      The scriptPath.

    • getScriptPathBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getScriptPathBytes()
       A path to the query's startup script in the controller's Git repository.
      string scriptPath = 17;
      Returns:
      The bytes for scriptPath.

    • getScriptLanguage

      String getScriptLanguage()
       The query's script language.  Groovy or Python are supported.
      string scriptLanguage = 18;
      Returns:
      The scriptLanguage.

    • getScriptLanguageBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getScriptLanguageBytes()
       The query's script language.  Groovy or Python are supported.
      string scriptLanguage = 18;
      Returns:
      The bytes for scriptLanguage.

    • getConfigurationType

      String getConfigurationType()
       What kind of query is this.  Typical values are "Script" or "RunAndDone".
      string configurationType = 19;
      Returns:
      The configurationType.

    • getConfigurationTypeBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getConfigurationTypeBytes()
       What kind of query is this.  Typical values are "Script" or "RunAndDone".
      string configurationType = 19;
      Returns:
      The bytes for configurationType.

    • hasTypeSpecificFieldsJson

      boolean hasTypeSpecificFieldsJson()
       JSON representing the fields for this configuration type.  The content of this field is dependent on configurationType.
      optional string typeSpecificFieldsJson = 20;
      Returns:
      Whether the typeSpecificFieldsJson field is set.

    • getTypeSpecificFieldsJson

      String getTypeSpecificFieldsJson()
       JSON representing the fields for this configuration type.  The content of this field is dependent on configurationType.
      optional string typeSpecificFieldsJson = 20;
      Returns:
      The typeSpecificFieldsJson.

    • getTypeSpecificFieldsJsonBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getTypeSpecificFieldsJsonBytes()
       JSON representing the fields for this configuration type.  The content of this field is dependent on configurationType.
      optional string typeSpecificFieldsJson = 20;
      Returns:
      The bytes for typeSpecificFieldsJson.

    • getSchedulingList

      List<String> getSchedulingList()
       An array of Strings that define when the query starts and stops.
      repeated string scheduling = 21;
      Returns:
      A list containing the scheduling.

    • getSchedulingCount

      int getSchedulingCount()
       An array of Strings that define when the query starts and stops.
      repeated string scheduling = 21;
      Returns:
      The count of scheduling.

    • getScheduling

      String getScheduling(int index)
       An array of Strings that define when the query starts and stops.
      repeated string scheduling = 21;
      Parameters:
      index - The index of the element to return.
      Returns:
      The scheduling at the given index.

    • getSchedulingBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getSchedulingBytes(int index)
       An array of Strings that define when the query starts and stops.
      repeated string scheduling = 21;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the scheduling at the given index.

    • getTimeoutNanos

      long getTimeoutNanos()
       How many nanoseconds to allow the query to initialize (or execute for batch queries).
      int64 timeoutNanos = 22;
      Returns:
      The timeoutNanos.

    • getJvmProfile

      String getJvmProfile()
       The jvm profile used by the query.
      string jvmProfile = 23;
      Returns:
      The jvmProfile.

    • getJvmProfileBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getJvmProfileBytes()
       The jvm profile used by the query.
      string jvmProfile = 23;
      Returns:
      The bytes for jvmProfile.

    • getLastModifiedByAuthenticated

      String getLastModifiedByAuthenticated()
       The authenticated user that last modified the configuration.
      string lastModifiedByAuthenticated = 24;
      Returns:
      The lastModifiedByAuthenticated.

    • getLastModifiedByAuthenticatedBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getLastModifiedByAuthenticatedBytes()
       The authenticated user that last modified the configuration.
      string lastModifiedByAuthenticated = 24;
      Returns:
      The bytes for lastModifiedByAuthenticated.

    • getLastModifiedByEffective

      String getLastModifiedByEffective()
       The effective user that last modified the configuration.
      string lastModifiedByEffective = 25;
      Returns:
      The lastModifiedByEffective.

    • getLastModifiedByEffectiveBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getLastModifiedByEffectiveBytes()
       The effective user that last modified the configuration.
      string lastModifiedByEffective = 25;
      Returns:
      The bytes for lastModifiedByEffective.

    • getLastModifiedTimeNanos

      long getLastModifiedTimeNanos()
       The last time the query was modified, in nanoseconds since the epoch.
      int64 lastModifiedTimeNanos = 26;
      Returns:
      The lastModifiedTimeNanos.

    • getCompletedStatus

      String getCompletedStatus()
       The status of a temporary query that has entered a terminal state.
      string completedStatus = 27;
      Returns:
      The completedStatus.

    • getCompletedStatusBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getCompletedStatusBytes()
       The status of a temporary query that has entered a terminal state.
      string completedStatus = 27;
      Returns:
      The bytes for completedStatus.

    • getExpirationTimeNanos

      long getExpirationTimeNanos()
       When this temporary query should be removed, in nanoseconds since the epoch.
      int64 expirationTimeNanos = 28;
      Returns:
      The expirationTimeNanos.

    • getKubernetesControl

      String getKubernetesControl()
       A JSON string that is used by the dispatcher to customize the worker’s pod when deployed on Kubernetes.
      string kubernetesControl = 29;
      Returns:
      The kubernetesControl.

    • getKubernetesControlBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getKubernetesControlBytes()
       A JSON string that is used by the dispatcher to customize the worker’s pod when deployed on Kubernetes.
      string kubernetesControl = 29;
      Returns:
      The bytes for kubernetesControl.

    • getWorkerKind

      String getWorkerKind()
       What kind of worker is this.  DeephavenEnterprise for Legacy workers.  DeephavenCommunity for Core+ workers.
      string workerKind = 30;
      Returns:
      The workerKind.

    • getWorkerKindBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getWorkerKindBytes()
       What kind of worker is this.  DeephavenEnterprise for Legacy workers.  DeephavenCommunity for Core+ workers.
      string workerKind = 30;
      Returns:
      The bytes for workerKind.

    • getCreatedTimeNanos

      long getCreatedTimeNanos()
       The query creation time, in nanoseconds since the epoch.
      int64 createdTimeNanos = 31;
      Returns:
      The createdTimeNanos.

    • getReplicaCount

      int getReplicaCount()
       The number of replicas to create and spread load across
      int32 replicaCount = 32;
      Returns:
      The replicaCount.

    • getSpareCount

      int getSpareCount()
       The number of spare workers to create and use as spares to replace failed replicas
      int32 spareCount = 33;
      Returns:
      The spareCount.

    • getAssignmentPolicy

      String getAssignmentPolicy()
       The policy the controller should use to assign clients to individual replicas
      string assignmentPolicy = 34;
      Returns:
      The assignmentPolicy.

    • getAssignmentPolicyBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getAssignmentPolicyBytes()
       The policy the controller should use to assign clients to individual replicas
      string assignmentPolicy = 34;
      Returns:
      The bytes for assignmentPolicy.

    • hasAssignmentPolicyParams

      boolean hasAssignmentPolicyParams()
       The policy parameters
      optional string assignmentPolicyParams = 35;
      Returns:
      Whether the assignmentPolicyParams field is set.

    • getAssignmentPolicyParams

      String getAssignmentPolicyParams()
       The policy parameters
      optional string assignmentPolicyParams = 35;
      Returns:
      The assignmentPolicyParams.

    • getAssignmentPolicyParamsBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getAssignmentPolicyParamsBytes()
       The policy parameters
      optional string assignmentPolicyParams = 35;
      Returns:
      The bytes for assignmentPolicyParams.

    • getAdditionalMemoryGb

      double getAdditionalMemoryGb()
       How much memory beyond the JVM should be allocated to this query?
      double additionalMemoryGb = 36;
      Returns:
      The additionalMemoryGb.

    • getPythonControl

      String getPythonControl()
       Core+ Python virtual environment control
      string pythonControl = 37;
      Returns:
      The pythonControl.

    • getPythonControlBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getPythonControlBytes()
       Core+ Python virtual environment control
      string pythonControl = 37;
      Returns:
      The bytes for pythonControl.

    • getGenericWorkerControl

      String getGenericWorkerControl()
       Generic worker control JSON
      string genericWorkerControl = 38;
      Returns:
      The genericWorkerControl.

    • getGenericWorkerControlBytes

      io.deephaven.shadow.core.com.google.protobuf.ByteString getGenericWorkerControlBytes()
       Generic worker control JSON
      string genericWorkerControl = 38;
      Returns:
      The bytes for genericWorkerControl.

    • getScriptDataCase

      PersistentQueryConfigMessage.ScriptDataCase getScriptDataCase()