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 Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_MAX_DURATION_MS`
`static int`	`DEFAULT_MAX_HEAP_SIZE_MB`
`static boolean`	`DEFAULT_WORKER_DEBUG_ENABLED`
`static int`	`MAX_MAX_DURATION_MS`
`static int`	`MAX_MAX_HEAP_SIZE_MB`
`static double`	`MINIMUM_HEAP_SIZE_GB`

Constructor Summary

Constructors
Constructor	Description
`RemoteProcessingRequest()`
`RemoteProcessingRequest(int maxHeapSizeMB, long maxDurationMS, String... extraJvmArgs)`
`RemoteProcessingRequest(com.fishlib.auth.AuthToken token)`
`RemoteProcessingRequest(com.fishlib.auth.AuthToken token, int maxHeapSizeMB, long maxDurationMS, String... extraJvmArgs)`
`RemoteProcessingRequest(com.fishlib.auth.AuthToken authToken, RemoteProcessingRequest other)`
`RemoteProcessingRequest(com.fishlib.auth.AuthToken token, String... extraJvmArgs)`
`RemoteProcessingRequest(com.fishlib.auth.AuthToken authToken, String description, int maxHeapSizeMB, long maxDurationMS, boolean omitDefaultGCParams, boolean detailedGCLoggingEnabled, String[] extraJvmArgs, boolean addClientClassesToClasspath, boolean enableCachedClasses, String[] classpathAdditions, int priority, boolean interactive, Map<String,String> extraEnvironmentVars)`
`RemoteProcessingRequest(RemoteProcessingRequest other)`
`RemoteProcessingRequest(String... extraJvmArgs)`
`RemoteProcessingRequest(String description, int maxHeapSizeMB, long maxDurationMS, boolean omitDefaultGCParams, boolean detailedGCLoggingEnabled, String[] extraJvmArgs, boolean addClientClassesToClasspath, boolean enableCachedClasses, String[] classpathAdditions, int priority, boolean interactive, Map<String,String> extraEnvironmentVars)`

Method Summary

Modifier and Type	Method	Description
`boolean`	`addClientClassesToClasspath()`
`boolean`	`detailedGCLoggingEnabled()`
`boolean`	`enableCachedClasses()`
`com.fishlib.auth.AuthToken`	`getAuthToken()`
`String[]`	`getClasspathAdditions()`
`String`	`getDescription()`
`Map<String,String>`	`getExtraEnvironmentVars()`
`String[]`	`getExtraJvmArgs()`
`String`	`getId()`
`long`	`getMaxDurationMS()`
`int`	`getMaxHeapSizeMB()`
`int`	`getPriority()`
`boolean`	`isInteractive()`
`boolean`	`omitDefaultGCParams()`
`void`	`setAddClientClassesToClasspath(boolean addClientClassesToClasspath)`
`void`	`setClasspathAdditions(String... classpathAdditions)`
`void`	`setDescription(String description)`
`void`	`setDetailedGCLoggingEnabled(boolean detailedGCLoggingEnabled)`
`void`	`setEnableCachedClasses(boolean enableCachedClasses)`
`void`	`setExtraEnvironmentVars(Map<String,String> extraEnvironmentVars)`
`void`	`setExtraJvmArgs(String... extraJvmArgs)`	Sets the extra JVM arguments that will be passed to the processor's JVM.
`void`	`setMaxDurationMS(long maxDurationMS)`
`void`	`setMaxHeapSizeMB(int maxHeapSizeMB)`
`void`	`setOmitDefaultGCParams(boolean omitDefaultGCParams)`
`void`	`setPriority(int priority)`

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- DEFAULT_MAX_HEAP_SIZE_MB
  
  public static final int DEFAULT_MAX_HEAP_SIZE_MB
- MAX_MAX_HEAP_SIZE_MB
  
  public static final int MAX_MAX_HEAP_SIZE_MB
  
  See Also:
  
  Constant Field Values
- MINIMUM_HEAP_SIZE_GB
  
  public static final double MINIMUM_HEAP_SIZE_GB
- DEFAULT_MAX_DURATION_MS
  
  public static final int DEFAULT_MAX_DURATION_MS
- MAX_MAX_DURATION_MS
  
  public static final int MAX_MAX_DURATION_MS
  
  See Also:
  
  Constant Field Values
- DEFAULT_WORKER_DEBUG_ENABLED
  
  public static final boolean DEFAULT_WORKER_DEBUG_ENABLED
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, boolean interactive, @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
  
  interactive - Should this job be treated as interactive?
  
  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, String description, int maxHeapSizeMB, long maxDurationMS, boolean omitDefaultGCParams, boolean detailedGCLoggingEnabled, String[] extraJvmArgs, boolean addClientClassesToClasspath, boolean enableCachedClasses, @Nullable String[] classpathAdditions, int priority, boolean interactive, @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
  
  interactive - Should this job be treated as interactive?
  
  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
- getId
  
  public String getId()
- getAuthToken
  
  public com.fishlib.auth.AuthToken getAuthToken()
- getDescription
  
  public String getDescription()
- setDescription
  
  public void setDescription(String description)
- getMaxHeapSizeMB
  
  public int getMaxHeapSizeMB()
- setMaxHeapSizeMB
  
  public void setMaxHeapSizeMB(int maxHeapSizeMB)
- getMaxDurationMS
  
  public long getMaxDurationMS()
- setMaxDurationMS
  
  public void setMaxDurationMS(long maxDurationMS)
- omitDefaultGCParams
  
  public boolean omitDefaultGCParams()
- setOmitDefaultGCParams
  
  public void setOmitDefaultGCParams(boolean omitDefaultGCParams)
- detailedGCLoggingEnabled
  
  public boolean detailedGCLoggingEnabled()
- setDetailedGCLoggingEnabled
  
  public void setDetailedGCLoggingEnabled(boolean detailedGCLoggingEnabled)
- getExtraJvmArgs
  
  public String[] getExtraJvmArgs()
- setExtraJvmArgs
  
  public void setExtraJvmArgs(String... extraJvmArgs)
  
  Sets the extra JVM arguments that will be passed to the processor's JVM. Note that you may only provide one argument per String. In other words, this is OK:
  rpr.setExtraJvmArgs("-DclientPort=7200", "-DdebugEnabled=false");
  But this is not OK:
  rpr.setExtraJvmArgs("-DclientPort=7200, -DdebugEnabled=false");
  
  Parameters:
  
  extraJvmArgs -
- isInteractive
  
  public boolean isInteractive()
- addClientClassesToClasspath
  
  public boolean addClientClassesToClasspath()
- setAddClientClassesToClasspath
  
  public void setAddClientClassesToClasspath(boolean addClientClassesToClasspath)
- enableCachedClasses
  
  public boolean enableCachedClasses()
- setEnableCachedClasses
  
  public void setEnableCachedClasses(boolean enableCachedClasses)
- getClasspathAdditions
  
  public String[] getClasspathAdditions()
- setClasspathAdditions
  
  public void setClasspathAdditions(String... classpathAdditions)
- getPriority
  
  public int getPriority()
- setPriority
  
  public void setPriority(int priority)
- getExtraEnvironmentVars
  
  public Map<String,String> getExtraEnvironmentVars()
- setExtraEnvironmentVars
  
  public void setExtraEnvironmentVars(Map<String,String> extraEnvironmentVars)

Class RemoteProcessingRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

Constructor Details

Method Details