Class RemoteProcessingRequest

java.lang.Object
com.illumon.iris.db.tables.remotequery.RemoteProcessingRequest
All Implemented Interfaces:
Serializable

public class RemoteProcessingRequest
extends Object
implements Serializable
Used for specifying the characteristics of a request for remote query processing.
See Also:
Serialized Form
  • Field Details

  • Constructor Details

    • RemoteProcessingRequest

      public RemoteProcessingRequest()
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(String... extraJvmArgs)
      Parameters:
      extraJvmArgs - Extra arguments that will be passed to the processor's JVM. See note on usage at setExtraJvmArgs(String...)
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(int maxHeapSizeMB, long maxDurationMS, String... extraJvmArgs)
      Parameters:
      maxHeapSizeMB - The amount of heap needed for queries - the assigned processor will have at *least* this much
      maxDurationMS - The maximum amount of time the query should take
      extraJvmArgs - Extra arguments that will be passed to the processor's JVM. See note on usage at setExtraJvmArgs(String...)
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(String description, int maxHeapSizeMB, long maxDurationMS, boolean omitDefaultGCParams, boolean detailedGCLoggingEnabled, String[] extraJvmArgs, boolean addClientClassesToClasspath, boolean enableCachedClasses, @Nullable String[] classpathAdditions, int priority, @Nullable Map<String,​String> extraEnvironmentVars)
      Parameters:
      description - A description for this job, to be displayed in status reports and performance logs
      maxHeapSizeMB - The amount of heap needed for queries - the assigned processor will have at *least* this much
      maxDurationMS - The maximum amount of time the query should take
      omitDefaultGCParams - Whether the dispatcher should supply default GC parameters
      detailedGCLoggingEnabled - Whether the dispatcher should supply detailed GC logging parameters
      extraJvmArgs - Extra arguments that will be passed to the processor's JVM. See note on usage at setExtraJvmArgs(String...)
      addClientClassesToClasspath - Whether to pre-pend the client connection's pushed classes directory to the processor's classpath
      enableCachedClasses - Whether to append the dispatcher's compiled class cache directory to the processor's classpath
      classpathAdditions - Extra directories on the *SERVER* to be pre-pended to the classpath for the assigned processor
      priority - User priority value to be used for processor scheduling - lower means more important
      extraEnvironmentVars - Environment variables to be set in the processor's environment. By default, environment is inherited from the dispatcher. Note: It's inadvisable to set enableCachedClasses=true if addClientClassesToClasspath==false.
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(com.fishlib.auth.AuthToken token)
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(com.fishlib.auth.AuthToken token, String... extraJvmArgs)
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(com.fishlib.auth.AuthToken token, int maxHeapSizeMB, long maxDurationMS, String... extraJvmArgs)
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(com.fishlib.auth.AuthToken authToken, @NotNull String description, int maxHeapSizeMB, long maxDurationMS, boolean omitDefaultGCParams, boolean detailedGCLoggingEnabled, String[] extraJvmArgs, boolean addClientClassesToClasspath, boolean enableCachedClasses, @Nullable String[] classpathAdditions, int priority, @Nullable Map<String,​String> extraEnvironmentVars)
      Parameters:
      authToken - An authentication token for the desired user context to be used for the new processor.
      description - A description for this job, to be displayed in status reports and performance logs
      maxHeapSizeMB - The amount of heap needed for queries - the assigned processor will have at *least* this much
      maxDurationMS - The maximum amount of time the query should take
      omitDefaultGCParams - Whether the dispatcher should supply default GC parameters
      detailedGCLoggingEnabled - Whether the dispatcher should supply detailed GC logging parameters
      extraJvmArgs - Extra arguments that will be passed to the processor's JVM. See note on usage at setExtraJvmArgs(String...)
      addClientClassesToClasspath - Whether to pre-pend the client connection's pushed classes directory to the processor's classpath
      enableCachedClasses - Whether to append the dispatcher's compiled class cache directory to the processor's classpath
      classpathAdditions - Extra directories on the *SERVER* to be pre-pended to the classpath for the assigned processor
      priority - User priority value to be used for processor scheduling - lower means more important
      extraEnvironmentVars - Environment variables to be set in the processor's environment. By default, environment is inherited from the dispatcher. Note: It's inadvisable to set enableCachedClasses=true if addClientClassesToClasspath==false.
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(@NotNull RemoteProcessingRequest other)
    • RemoteProcessingRequest

      public RemoteProcessingRequest​(@NotNull com.fishlib.auth.AuthToken authToken, @NotNull RemoteProcessingRequest other)
  • Method Details