Package io.deephaven.proto.controller
Class PersistentQueryConfigMessage
java.lang.Object
io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite
io.deephaven.shadow.core.com.google.protobuf.AbstractMessage
io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
io.deephaven.proto.controller.PersistentQueryConfigMessage
- All Implemented Interfaces:
PersistentQueryConfigMessageOrBuilder
,io.deephaven.shadow.core.com.google.protobuf.Message
,io.deephaven.shadow.core.com.google.protobuf.MessageLite
,io.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
,io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
,Serializable
public final class PersistentQueryConfigMessage
extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
implements PersistentQueryConfigMessageOrBuilder
Protobuf type
io.deephaven.proto.controller.PersistentQueryConfigMessage
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Protobuf typeio.deephaven.proto.controller.PersistentQueryConfigMessage
static enum
Nested classes/interfaces inherited from class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.BuilderParent, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite
io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getAdminGroups
(int index) Groups that may administer the query.io.deephaven.shadow.core.com.google.protobuf.ByteString
getAdminGroupsBytes
(int index) Groups that may administer the query.int
Groups that may administer the query.io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList
Groups that may administer the query.double
double bufferPoolToHeapRatio = 7;
getClassPathAdditions
(int index) Extra paths to include in the queries class path.io.deephaven.shadow.core.com.google.protobuf.ByteString
getClassPathAdditionsBytes
(int index) Extra paths to include in the queries class path.int
Extra paths to include in the queries class path.io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList
Extra paths to include in the queries class path.The status of a temporary query that has entered a terminal state.io.deephaven.shadow.core.com.google.protobuf.ByteString
The status of a temporary query that has entered a terminal state.What kind of query is this.io.deephaven.shadow.core.com.google.protobuf.ByteString
What kind of query is this.long
The query creation time, in nanoseconds since the epoch.static PersistentQueryConfigMessage
static final io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor
boolean
bool detailedGCLoggingEnabled = 8;
boolean
Is this query enabled? Enabled queries can be executed, disable queries cannot.long
When this temporary query should be removed, in nanoseconds since the epoch.getExtraEnvironmentVariables
(int index) Extra environment variables for this query.io.deephaven.shadow.core.com.google.protobuf.ByteString
getExtraEnvironmentVariablesBytes
(int index) Extra environment variables for this query.int
Extra environment variables for this query.io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList
Extra environment variables for this query.getExtraJvmArguments
(int index) Extra JVM arguments for this query.io.deephaven.shadow.core.com.google.protobuf.ByteString
getExtraJvmArgumentsBytes
(int index) Extra JVM arguments for this query.int
Extra JVM arguments for this query.io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList
Extra JVM arguments for this query.double
How much heap should be allocated to this query?The jvm profile used by the query.io.deephaven.shadow.core.com.google.protobuf.ByteString
The jvm profile used by the query.A JSON string thatio.deephaven.shadow.core.com.google.protobuf.ByteString
A JSON string thatThe authenticated user that last modified the configuration.io.deephaven.shadow.core.com.google.protobuf.ByteString
The authenticated user that last modified the configuration.The effective user that last modified the configuration.io.deephaven.shadow.core.com.google.protobuf.ByteString
The effective user that last modified the configuration.long
The last time the query was modified, in nanoseconds since the epoch.getName()
The name of this persistent query.io.deephaven.shadow.core.com.google.protobuf.ByteString
The name of this persistent query.getOwner()
The owner of the query.io.deephaven.shadow.core.com.google.protobuf.ByteString
The owner of the query.io.deephaven.shadow.core.com.google.protobuf.Parser<PersistentQueryConfigMessage>
Controls the behavior of who can restart the query (admins, viewers, or viewers when down).int
Controls the behavior of who can restart the query (admins, viewers, or viewers when down).getScheduling
(int index) An array of Strings that define when the query starts and stops.io.deephaven.shadow.core.com.google.protobuf.ByteString
getSchedulingBytes
(int index) An array of Strings that define when the query starts and stops.int
An array of Strings that define when the query starts and stops.io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList
An array of Strings that define when the query starts and stops.The text of the query's startup script.io.deephaven.shadow.core.com.google.protobuf.ByteString
The text of the query's startup script.The query's script language.io.deephaven.shadow.core.com.google.protobuf.ByteString
The query's script language.A path to the query's startup script in the controller's Git repository.io.deephaven.shadow.core.com.google.protobuf.ByteString
A path to the query's startup script in the controller's Git repository.long
The serial number is a unique identifier for this persistent query.int
The server to execute on.io.deephaven.shadow.core.com.google.protobuf.ByteString
The server to execute on.long
How many nanoseconds to allow the query to initialize (or execute for batch queries).JSON representing the fields for this configuration type.io.deephaven.shadow.core.com.google.protobuf.ByteString
JSON representing the fields for this configuration type.final io.deephaven.shadow.core.com.google.protobuf.UnknownFieldSet
long
The modification version of this persistent query, which increases by one each time the configuration is modified.getViewerGroups
(int index) Groups that may view the query.io.deephaven.shadow.core.com.google.protobuf.ByteString
getViewerGroupsBytes
(int index) Groups that may view the query.int
Groups that may view the query.io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList
Groups that may view the query.What kind of worker is this.io.deephaven.shadow.core.com.google.protobuf.ByteString
What kind of worker is this.int
hashCode()
boolean
The text of the query's startup script.boolean
A path to the query's startup script in the controller's Git repository.boolean
JSON representing the fields for this configuration type.protected io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
newBuilder
(PersistentQueryConfigMessage prototype) protected PersistentQueryConfigMessage.Builder
newBuilderForType
(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static PersistentQueryConfigMessage
parseDelimitedFrom
(InputStream input) static PersistentQueryConfigMessage
parseDelimitedFrom
(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PersistentQueryConfigMessage
parseFrom
(byte[] data) static PersistentQueryConfigMessage
parseFrom
(byte[] data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PersistentQueryConfigMessage
parseFrom
(io.deephaven.shadow.core.com.google.protobuf.ByteString data) static PersistentQueryConfigMessage
parseFrom
(io.deephaven.shadow.core.com.google.protobuf.ByteString data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PersistentQueryConfigMessage
parseFrom
(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input) static PersistentQueryConfigMessage
parseFrom
(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PersistentQueryConfigMessage
parseFrom
(InputStream input) static PersistentQueryConfigMessage
parseFrom
(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PersistentQueryConfigMessage
parseFrom
(ByteBuffer data) static PersistentQueryConfigMessage
parseFrom
(ByteBuffer data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) static io.deephaven.shadow.core.com.google.protobuf.Parser<PersistentQueryConfigMessage>
parser()
void
writeTo
(io.deephaven.shadow.core.com.google.protobuf.CodedOutputStream output) Methods inherited from class io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class io.deephaven.shadow.core.com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface io.deephaven.shadow.core.com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface io.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof
-
Field Details
-
SERIAL_FIELD_NUMBER
public static final int SERIAL_FIELD_NUMBER- See Also:
-
VERSION_FIELD_NUMBER
public static final int VERSION_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
OWNER_FIELD_NUMBER
public static final int OWNER_FIELD_NUMBER- See Also:
-
ENABLED_FIELD_NUMBER
public static final int ENABLED_FIELD_NUMBER- See Also:
-
HEAPSIZEGB_FIELD_NUMBER
public static final int HEAPSIZEGB_FIELD_NUMBER- See Also:
-
BUFFERPOOLTOHEAPRATIO_FIELD_NUMBER
public static final int BUFFERPOOLTOHEAPRATIO_FIELD_NUMBER- See Also:
-
DETAILEDGCLOGGINGENABLED_FIELD_NUMBER
public static final int DETAILEDGCLOGGINGENABLED_FIELD_NUMBER- See Also:
-
EXTRAJVMARGUMENTS_FIELD_NUMBER
public static final int EXTRAJVMARGUMENTS_FIELD_NUMBER- See Also:
-
EXTRAENVIRONMENTVARIABLES_FIELD_NUMBER
public static final int EXTRAENVIRONMENTVARIABLES_FIELD_NUMBER- See Also:
-
CLASSPATHADDITIONS_FIELD_NUMBER
public static final int CLASSPATHADDITIONS_FIELD_NUMBER- See Also:
-
SERVERNAME_FIELD_NUMBER
public static final int SERVERNAME_FIELD_NUMBER- See Also:
-
ADMINGROUPS_FIELD_NUMBER
public static final int ADMINGROUPS_FIELD_NUMBER- See Also:
-
VIEWERGROUPS_FIELD_NUMBER
public static final int VIEWERGROUPS_FIELD_NUMBER- See Also:
-
RESTARTUSERS_FIELD_NUMBER
public static final int RESTARTUSERS_FIELD_NUMBER- See Also:
-
SCRIPTCODE_FIELD_NUMBER
public static final int SCRIPTCODE_FIELD_NUMBER- See Also:
-
SCRIPTPATH_FIELD_NUMBER
public static final int SCRIPTPATH_FIELD_NUMBER- See Also:
-
SCRIPTLANGUAGE_FIELD_NUMBER
public static final int SCRIPTLANGUAGE_FIELD_NUMBER- See Also:
-
CONFIGURATIONTYPE_FIELD_NUMBER
public static final int CONFIGURATIONTYPE_FIELD_NUMBER- See Also:
-
TYPESPECIFICFIELDSJSON_FIELD_NUMBER
public static final int TYPESPECIFICFIELDSJSON_FIELD_NUMBER- See Also:
-
SCHEDULING_FIELD_NUMBER
public static final int SCHEDULING_FIELD_NUMBER- See Also:
-
TIMEOUTNANOS_FIELD_NUMBER
public static final int TIMEOUTNANOS_FIELD_NUMBER- See Also:
-
JVMPROFILE_FIELD_NUMBER
public static final int JVMPROFILE_FIELD_NUMBER- See Also:
-
LASTMODIFIEDBYAUTHENTICATED_FIELD_NUMBER
public static final int LASTMODIFIEDBYAUTHENTICATED_FIELD_NUMBER- See Also:
-
LASTMODIFIEDBYEFFECTIVE_FIELD_NUMBER
public static final int LASTMODIFIEDBYEFFECTIVE_FIELD_NUMBER- See Also:
-
LASTMODIFIEDTIMENANOS_FIELD_NUMBER
public static final int LASTMODIFIEDTIMENANOS_FIELD_NUMBER- See Also:
-
COMPLETEDSTATUS_FIELD_NUMBER
public static final int COMPLETEDSTATUS_FIELD_NUMBER- See Also:
-
EXPIRATIONTIMENANOS_FIELD_NUMBER
public static final int EXPIRATIONTIMENANOS_FIELD_NUMBER- See Also:
-
KUBERNETESCONTROL_FIELD_NUMBER
public static final int KUBERNETESCONTROL_FIELD_NUMBER- See Also:
-
WORKERKIND_FIELD_NUMBER
public static final int WORKERKIND_FIELD_NUMBER- See Also:
-
CREATEDTIMENANOS_FIELD_NUMBER
public static final int CREATEDTIMENANOS_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
protected Object newInstance(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) - Overrides:
newInstance
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
getUnknownFields
public final io.deephaven.shadow.core.com.google.protobuf.UnknownFieldSet getUnknownFields()- Specified by:
getUnknownFields
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
- Overrides:
getUnknownFields
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final io.deephaven.shadow.core.com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
getScriptDataCase
- Specified by:
getScriptDataCase
in interfacePersistentQueryConfigMessageOrBuilder
-
getSerial
public 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;
- Specified by:
getSerial
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The serial.
-
getVersion
public long getVersion()The modification version of this persistent query, which increases by one each time the configuration is modified.
int64 version = 2;
- Specified by:
getVersion
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The version.
-
getName
The name of this persistent query. Currently, the name must be unique to make diagnosing problems easier.
string name = 3;
- Specified by:
getName
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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;
- Specified by:
getNameBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for name.
-
getOwner
The owner of the query. The query runs in the user context of the owner.
string owner = 4;
- Specified by:
getOwner
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The owner.
-
getOwnerBytes
public 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;
- Specified by:
getOwnerBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for owner.
-
getEnabled
public boolean getEnabled()Is this query enabled? Enabled queries can be executed, disable queries cannot.
bool enabled = 5;
- Specified by:
getEnabled
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The enabled.
-
getHeapSizeGb
public double getHeapSizeGb()How much heap should be allocated to this query?
double heapSizeGb = 6;
- Specified by:
getHeapSizeGb
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The heapSizeGb.
-
getBufferPoolToHeapRatio
public double getBufferPoolToHeapRatio()double bufferPoolToHeapRatio = 7;
- Specified by:
getBufferPoolToHeapRatio
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bufferPoolToHeapRatio.
-
getDetailedGCLoggingEnabled
public boolean getDetailedGCLoggingEnabled()bool detailedGCLoggingEnabled = 8;
- Specified by:
getDetailedGCLoggingEnabled
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The detailedGCLoggingEnabled.
-
getExtraJvmArgumentsList
public io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList getExtraJvmArgumentsList()Extra JVM arguments for this query.
repeated string extraJvmArguments = 9;
- Specified by:
getExtraJvmArgumentsList
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- A list containing the extraJvmArguments.
-
getExtraJvmArgumentsCount
public int getExtraJvmArgumentsCount()Extra JVM arguments for this query.
repeated string extraJvmArguments = 9;
- Specified by:
getExtraJvmArgumentsCount
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The count of extraJvmArguments.
-
getExtraJvmArguments
Extra JVM arguments for this query.
repeated string extraJvmArguments = 9;
- Specified by:
getExtraJvmArguments
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The extraJvmArguments at the given index.
-
getExtraJvmArgumentsBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getExtraJvmArgumentsBytes(int index) Extra JVM arguments for this query.
repeated string extraJvmArguments = 9;
- Specified by:
getExtraJvmArgumentsBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the extraJvmArguments at the given index.
-
getExtraEnvironmentVariablesList
public io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList getExtraEnvironmentVariablesList()Extra environment variables for this query.
repeated string extraEnvironmentVariables = 10;
- Specified by:
getExtraEnvironmentVariablesList
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- A list containing the extraEnvironmentVariables.
-
getExtraEnvironmentVariablesCount
public int getExtraEnvironmentVariablesCount()Extra environment variables for this query.
repeated string extraEnvironmentVariables = 10;
- Specified by:
getExtraEnvironmentVariablesCount
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The count of extraEnvironmentVariables.
-
getExtraEnvironmentVariables
Extra environment variables for this query.
repeated string extraEnvironmentVariables = 10;
- Specified by:
getExtraEnvironmentVariables
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The extraEnvironmentVariables at the given index.
-
getExtraEnvironmentVariablesBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getExtraEnvironmentVariablesBytes(int index) Extra environment variables for this query.
repeated string extraEnvironmentVariables = 10;
- Specified by:
getExtraEnvironmentVariablesBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the extraEnvironmentVariables at the given index.
-
getClassPathAdditionsList
public io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList 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;
- Specified by:
getClassPathAdditionsList
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- A list containing the classPathAdditions.
-
getClassPathAdditionsCount
public 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;
- Specified by:
getClassPathAdditionsCount
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The count of classPathAdditions.
-
getClassPathAdditions
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;
- Specified by:
getClassPathAdditions
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The classPathAdditions at the given index.
-
getClassPathAdditionsBytes
public 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;
- Specified by:
getClassPathAdditionsBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the classPathAdditions at the given index.
-
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;
- Specified by:
getServerName
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The serverName.
-
getServerNameBytes
public 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;
- Specified by:
getServerNameBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for serverName.
-
getAdminGroupsList
public io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList 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;
- Specified by:
getAdminGroupsList
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- A list containing the adminGroups.
-
getAdminGroupsCount
public 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;
- Specified by:
getAdminGroupsCount
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The count of adminGroups.
-
getAdminGroups
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;
- Specified by:
getAdminGroups
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The adminGroups at the given index.
-
getAdminGroupsBytes
public 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;
- Specified by:
getAdminGroupsBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the adminGroups at the given index.
-
getViewerGroupsList
public io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList getViewerGroupsList()Groups that may view the query.
repeated string viewerGroups = 14;
- Specified by:
getViewerGroupsList
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- A list containing the viewerGroups.
-
getViewerGroupsCount
public int getViewerGroupsCount()Groups that may view the query.
repeated string viewerGroups = 14;
- Specified by:
getViewerGroupsCount
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The count of viewerGroups.
-
getViewerGroups
Groups that may view the query.
repeated string viewerGroups = 14;
- Specified by:
getViewerGroups
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The viewerGroups at the given index.
-
getViewerGroupsBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getViewerGroupsBytes(int index) Groups that may view the query.
repeated string viewerGroups = 14;
- Specified by:
getViewerGroupsBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the viewerGroups at the given index.
-
getRestartUsersValue
public int getRestartUsersValue()Controls the behavior of who can restart the query (admins, viewers, or viewers when down).
.io.deephaven.proto.controller.RestartUsersEnum restartUsers = 15;
- Specified by:
getRestartUsersValue
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The enum numeric value on the wire for restartUsers.
-
getRestartUsers
Controls the behavior of who can restart the query (admins, viewers, or viewers when down).
.io.deephaven.proto.controller.RestartUsersEnum restartUsers = 15;
- Specified by:
getRestartUsers
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The restartUsers.
-
hasScriptCode
public boolean hasScriptCode()The text of the query's startup script.
string scriptCode = 16;
- Specified by:
hasScriptCode
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- Whether the scriptCode field is set.
-
getScriptCode
The text of the query's startup script.
string scriptCode = 16;
- Specified by:
getScriptCode
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The scriptCode.
-
getScriptCodeBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getScriptCodeBytes()The text of the query's startup script.
string scriptCode = 16;
- Specified by:
getScriptCodeBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for scriptCode.
-
hasScriptPath
public boolean hasScriptPath()A path to the query's startup script in the controller's Git repository.
string scriptPath = 17;
- Specified by:
hasScriptPath
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- Whether the scriptPath field is set.
-
getScriptPath
A path to the query's startup script in the controller's Git repository.
string scriptPath = 17;
- Specified by:
getScriptPath
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The scriptPath.
-
getScriptPathBytes
public 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;
- Specified by:
getScriptPathBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for scriptPath.
-
getScriptLanguage
The query's script language. Groovy or Python are supported.
string scriptLanguage = 18;
- Specified by:
getScriptLanguage
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The scriptLanguage.
-
getScriptLanguageBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getScriptLanguageBytes()The query's script language. Groovy or Python are supported.
string scriptLanguage = 18;
- Specified by:
getScriptLanguageBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for scriptLanguage.
-
getConfigurationType
What kind of query is this. Typical values are "Script" or "RunAndDone".
string configurationType = 19;
- Specified by:
getConfigurationType
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The configurationType.
-
getConfigurationTypeBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getConfigurationTypeBytes()What kind of query is this. Typical values are "Script" or "RunAndDone".
string configurationType = 19;
- Specified by:
getConfigurationTypeBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for configurationType.
-
hasTypeSpecificFieldsJson
public boolean hasTypeSpecificFieldsJson()JSON representing the fields for this configuration type. The content of this field is dependent on configurationType.
optional string typeSpecificFieldsJson = 20;
- Specified by:
hasTypeSpecificFieldsJson
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- Whether the typeSpecificFieldsJson field is set.
-
getTypeSpecificFieldsJson
JSON representing the fields for this configuration type. The content of this field is dependent on configurationType.
optional string typeSpecificFieldsJson = 20;
- Specified by:
getTypeSpecificFieldsJson
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The typeSpecificFieldsJson.
-
getTypeSpecificFieldsJsonBytes
public 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;
- Specified by:
getTypeSpecificFieldsJsonBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for typeSpecificFieldsJson.
-
getSchedulingList
public io.deephaven.shadow.core.com.google.protobuf.ProtocolStringList getSchedulingList()An array of Strings that define when the query starts and stops.
repeated string scheduling = 21;
- Specified by:
getSchedulingList
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- A list containing the scheduling.
-
getSchedulingCount
public int getSchedulingCount()An array of Strings that define when the query starts and stops.
repeated string scheduling = 21;
- Specified by:
getSchedulingCount
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The count of scheduling.
-
getScheduling
An array of Strings that define when the query starts and stops.
repeated string scheduling = 21;
- Specified by:
getScheduling
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The scheduling at the given index.
-
getSchedulingBytes
public 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;
- Specified by:
getSchedulingBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the scheduling at the given index.
-
getTimeoutNanos
public long getTimeoutNanos()How many nanoseconds to allow the query to initialize (or execute for batch queries).
int64 timeoutNanos = 22;
- Specified by:
getTimeoutNanos
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The timeoutNanos.
-
getJvmProfile
The jvm profile used by the query.
string jvmProfile = 23;
- Specified by:
getJvmProfile
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The jvmProfile.
-
getJvmProfileBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getJvmProfileBytes()The jvm profile used by the query.
string jvmProfile = 23;
- Specified by:
getJvmProfileBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for jvmProfile.
-
getLastModifiedByAuthenticated
The authenticated user that last modified the configuration.
string lastModifiedByAuthenticated = 24;
- Specified by:
getLastModifiedByAuthenticated
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The lastModifiedByAuthenticated.
-
getLastModifiedByAuthenticatedBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getLastModifiedByAuthenticatedBytes()The authenticated user that last modified the configuration.
string lastModifiedByAuthenticated = 24;
- Specified by:
getLastModifiedByAuthenticatedBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for lastModifiedByAuthenticated.
-
getLastModifiedByEffective
The effective user that last modified the configuration.
string lastModifiedByEffective = 25;
- Specified by:
getLastModifiedByEffective
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The lastModifiedByEffective.
-
getLastModifiedByEffectiveBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getLastModifiedByEffectiveBytes()The effective user that last modified the configuration.
string lastModifiedByEffective = 25;
- Specified by:
getLastModifiedByEffectiveBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for lastModifiedByEffective.
-
getLastModifiedTimeNanos
public long getLastModifiedTimeNanos()The last time the query was modified, in nanoseconds since the epoch.
int64 lastModifiedTimeNanos = 26;
- Specified by:
getLastModifiedTimeNanos
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The lastModifiedTimeNanos.
-
getCompletedStatus
The status of a temporary query that has entered a terminal state.
string completedStatus = 27;
- Specified by:
getCompletedStatus
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The completedStatus.
-
getCompletedStatusBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getCompletedStatusBytes()The status of a temporary query that has entered a terminal state.
string completedStatus = 27;
- Specified by:
getCompletedStatusBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for completedStatus.
-
getExpirationTimeNanos
public long getExpirationTimeNanos()When this temporary query should be removed, in nanoseconds since the epoch.
int64 expirationTimeNanos = 28;
- Specified by:
getExpirationTimeNanos
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The expirationTimeNanos.
-
getKubernetesControl
A JSON string that
string kubernetesControl = 29;
- Specified by:
getKubernetesControl
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The kubernetesControl.
-
getKubernetesControlBytes
public io.deephaven.shadow.core.com.google.protobuf.ByteString getKubernetesControlBytes()A JSON string that
string kubernetesControl = 29;
- Specified by:
getKubernetesControlBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for kubernetesControl.
-
getWorkerKind
What kind of worker is this. DeephavenEnterprise for Legacy workers. DeephavenCommunity for Core+ workers.
string workerKind = 30;
- Specified by:
getWorkerKind
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The workerKind.
-
getWorkerKindBytes
public 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;
- Specified by:
getWorkerKindBytes
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The bytes for workerKind.
-
getCreatedTimeNanos
public long getCreatedTimeNanos()The query creation time, in nanoseconds since the epoch.
int64 createdTimeNanos = 31;
- Specified by:
getCreatedTimeNanos
in interfacePersistentQueryConfigMessageOrBuilder
- Returns:
- The createdTimeNanos.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
writeTo
public void writeTo(io.deephaven.shadow.core.com.google.protobuf.CodedOutputStream output) throws IOException - Specified by:
writeTo
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLite
- Overrides:
writeTo
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfaceio.deephaven.shadow.core.com.google.protobuf.Message
- Overrides:
equals
in classio.deephaven.shadow.core.com.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfaceio.deephaven.shadow.core.com.google.protobuf.Message
- Overrides:
hashCode
in classio.deephaven.shadow.core.com.google.protobuf.AbstractMessage
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(ByteBuffer data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException - Throws:
io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(ByteBuffer data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException - Throws:
io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException - Throws:
io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(io.deephaven.shadow.core.com.google.protobuf.ByteString data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException - Throws:
io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(byte[] data) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException - Throws:
io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(byte[] data, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException - Throws:
io.deephaven.shadow.core.com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static PersistentQueryConfigMessage parseDelimitedFrom(InputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static PersistentQueryConfigMessage parseFrom(io.deephaven.shadow.core.com.google.protobuf.CodedInputStream input, io.deephaven.shadow.core.com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfaceio.deephaven.shadow.core.com.google.protobuf.Message
- Specified by:
newBuilderForType
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
public static PersistentQueryConfigMessage.Builder newBuilder(PersistentQueryConfigMessage prototype) -
toBuilder
- Specified by:
toBuilder
in interfaceio.deephaven.shadow.core.com.google.protobuf.Message
- Specified by:
toBuilder
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLite
-
newBuilderForType
protected PersistentQueryConfigMessage.Builder newBuilderForType(io.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
public static io.deephaven.shadow.core.com.google.protobuf.Parser<PersistentQueryConfigMessage> parser() -
getParserForType
public io.deephaven.shadow.core.com.google.protobuf.Parser<PersistentQueryConfigMessage> getParserForType()- Specified by:
getParserForType
in interfaceio.deephaven.shadow.core.com.google.protobuf.Message
- Specified by:
getParserForType
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLite
- Overrides:
getParserForType
in classio.deephaven.shadow.core.com.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfaceio.deephaven.shadow.core.com.google.protobuf.MessageOrBuilder
-