H2O (h2o-core version 3.10.0.3 API)

java.lang.Object
- water.H2O

public final class H2O
extends java.lang.Object

Start point for creating or joining an H2O Cloud.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`H2O.AboutEntry`
`static class`	`H2O.FJWThr`
`static class`	`H2O.GAStartupReportThread`
`static class`	`H2O.H2OCallback<T extends H2O.H2OCountedCompleter>`
`static class`	`H2O.H2OCountedCompleter<T extends H2O.H2OCountedCompleter>` Simple wrapper over F/J `CountedCompleter` to support priority queues.
`static class`	`H2O.H2OFuture<T>`
`static class`	`H2O.OptArgs` A class containing all of the arguments for H2O.
`static class`	`H2O.OptString`

Field Summary

Fields
Modifier and Type	Field and Description
`H2ONode[]`	`_memary`
`static AbstractBuildVersion`	`ABV`
`static byte`	`ACK_ACK_PRIORITY`
`static byte`	`ACK_PRIORITY`
`static int`	`API_PORT`
`static H2O.OptArgs`	`ARGS` Singleton ARGS instance that contains the processed arguments.
`static byte`	`ATOMIC_PRIORITY`
`static int`	`CLIENT_ID_GA_CUST_DIM`
`static int`	`CLIENT_TYPE_GA_CUST_DIM`
`static H2O`	`CLOUD`
`static java.net.InetAddress`	`CLOUD_MULTICAST_GROUP`
`static java.net.NetworkInterface`	`CLOUD_MULTICAST_IF`
`static int`	`CLOUD_MULTICAST_PORT`
`static java.net.MulticastSocket`	`CLOUD_MULTICAST_SOCKET`
`static long`	`CLUSTER_ID`
`static java.lang.String`	`DEFAULT_JKS_PASS`
`static byte`	`DESERIAL_PRIORITY`
`static AbstractEmbeddedH2OConfig`	`embeddedH2OConfig`
`static byte`	`FETCH_ACK_PRIORITY`
`static com.brsanthu.googleanalytics.GoogleAnalytics`	`GA`
`static byte`	`GET_KEY_PRIORITY`
`static byte`	`GUI_PRIORITY`
`static int`	`H2O_PORT`
`static java.net.URI`	`ICE_ROOT`
`static byte`	`INVALIDATE_PRIORITY`
`static int`	`LOW_PRIORITY_API_WORK`
`static java.lang.String`	`LOW_PRIORITY_API_WORK_CLASS`
`static byte`	`MAX_PRIORITY`
`static byte`	`MIN_HI_PRIORITY`
`static byte`	`MIN_PRIORITY`
`static int`	`NUMCPUS`
`static long`	`PID`
`static byte`	`PUT_KEY_PRIORITY`
`static H2ONode`	`SELF` Myself, as a Node in the Cloud
`static java.net.InetAddress`	`SELF_ADDRESS` IP address of this node used for communication with other nodes.
`static java.util.concurrent.atomic.AtomicLong`	`START_TIME_MILLIS`
`static java.util.HashSet<H2ONode>`	`STATIC_H2OS`
`static water.nbhm.NonBlockingHashMap<Key,Value>`	`STORE`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`addAboutEntry(java.lang.String name, java.lang.String value)`
`static void`	`addExtension(AbstractH2OExtension e)`
`static java.lang.String`	`calcNextUniqueModelId(java.lang.String desc)` Calculate a unique model id that includes User-Agent info (if it can be discovered).
`static void`	`closeAll()`
`static void`	`configureLogging()`
`static boolean`	`containsKey(Key key)`
`static java.lang.String`	`DEFAULT_FLOW_DIR()`
`static java.lang.String`	`DEFAULT_ICE_ROOT()`
`static void`	`die(java.lang.String s)`
`static void`	`exit(int status)` Notify embedding software instance H2O wants to exit.
`static H2OFailException`	`fail()`
`static H2OFailException`	`fail(java.lang.String msg)`
`static H2OFailException`	`fail(java.lang.String msg, java.lang.Throwable cause)` H2O.fail is intended to be used in code where something should never happen, and if it does it's a coding error that needs to be addressed immediately.
`static void`	`finalizeRegistration()` Start the web service; disallow future URL registration.
`long`	`free_mem()`
`static void`	`gc()` Run System.gc() on every node in the H2O cluster.
`static java.util.ArrayList<H2O.AboutEntry>`	`getAboutEntries()`
`static int`	`getCloudSize()`
`static AbstractEmbeddedH2OConfig`	`getEmbeddedH2OConfig()`
`static java.util.ArrayList<AbstractH2OExtension>`	`getExtensions()`
`static java.lang.String`	`getIpPortString()`
`static JettyHTTPD`	`getJetty()`
`static ModelCacheManager`	`getMCM()`
`static NodePersistentStorage`	`getNPS()`
`static PersistManager`	`getPM()`
`static boolean`	`getShutdownRequested()`
`static java.lang.String`	`getURL(java.lang.String schema)`
`static boolean`	`haveInheritedLog4jConfiguration()`
`boolean`	`healthy()`
`static void`	`joinOthers()`
`static java.util.Set<Key>`	`localKeySet()`
`static void`	`main(java.lang.String[] args)`
`H2ONode[]`	`members()`
`static void`	`notifyAboutCloudSize(java.net.InetAddress ip, int port, int size)` Tell the embedding software that this H2O instance belongs to a cloud of a certain size.
`static int`	`orderlyShutdown()`
`static int`	`orderlyShutdown(int timeout)`
`static void`	`parseFailed(java.lang.String message)`
`static void`	`printHelp()` Print help about command line arguments.
`static Value`	`putIfMatch(Key key, Value val, Value old)`
`static void`	`raw_clear()`
`static void`	`raw_remove(Key key)`
`static void`	`register(java.lang.String method_url, java.lang.Class<? extends Handler> hclass, java.lang.String method, java.lang.String apiName, java.lang.String summary)`
`static void`	`registerExtensions()` Register H2O extensions.
`static void`	`registerResourceRoot(java.io.File f)`
`static void`	`registerRestApis(java.lang.String relativeResourcePath)` Register REST API routes.
`static void`	`requestShutdown()`
`static void`	`setEmbeddedH2OConfig(AbstractEmbeddedH2OConfig c)` Register embedded H2O configuration object with H2O instance.
`static void`	`setJetty(JettyHTTPD value)`
`static void`	`shutdown(int status)` Cluster shutdown itself by sending a shutdown UDP packet.
`int`	`size()`
`static int`	`store_size()`
`static java.lang.String`	`STOREtoString()`
`static <T extends H2O.H2OCountedCompleter> T`	`submitTask(T task)`
`static java.lang.String`	`technote(int[] numbers, java.lang.String message)` Return an error message with an accompanying list of URLs to help the user get more detailed information.
`static java.lang.String`	`technote(int number, java.lang.String message)` Return an error message with an accompanying URL to help the user get more detailed information.
`java.lang.String`	`toString()`
`static H2OIllegalArgumentException`	`unimpl()` Throw an exception that will cause the request to fail, but the cluster to continue.
`static H2OIllegalArgumentException`	`unimpl(java.lang.String msg)` Throw an exception that will cause the request to fail, but the cluster to continue.
`static void`	`waitForCloudSize(int x, long ms)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_JKS_PASS
```
public static final java.lang.String DEFAULT_JKS_PASS
```
    See Also:
    Constant Field Values
  - ARGS
```
public static final H2O.OptArgs ARGS
```
    Singleton ARGS instance that contains the processed arguments.
  - GA
```
public static com.brsanthu.googleanalytics.GoogleAnalytics GA
```
  - CLIENT_TYPE_GA_CUST_DIM
```
public static int CLIENT_TYPE_GA_CUST_DIM
```
  - CLIENT_ID_GA_CUST_DIM
```
public static int CLIENT_ID_GA_CUST_DIM
```
  - embeddedH2OConfig
```
public static volatile AbstractEmbeddedH2OConfig embeddedH2OConfig
```
  - ABV
```
public static final AbstractBuildVersion ABV
```
  - START_TIME_MILLIS
```
public static final java.util.concurrent.atomic.AtomicLong START_TIME_MILLIS
```
  - NUMCPUS
```
public static final int NUMCPUS
```
  - PID
```
public static long PID
```
  - MAX_PRIORITY
```
public static final byte MAX_PRIORITY
```
    See Also:
    Constant Field Values
  - ACK_ACK_PRIORITY
```
public static final byte ACK_ACK_PRIORITY
```
    See Also:
    Constant Field Values
  - FETCH_ACK_PRIORITY
```
public static final byte FETCH_ACK_PRIORITY
```
    See Also:
    Constant Field Values
  - ACK_PRIORITY
```
public static final byte ACK_PRIORITY
```
    See Also:
    Constant Field Values
  - DESERIAL_PRIORITY
```
public static final byte DESERIAL_PRIORITY
```
    See Also:
    Constant Field Values
  - INVALIDATE_PRIORITY
```
public static final byte INVALIDATE_PRIORITY
```
    See Also:
    Constant Field Values
  - GET_KEY_PRIORITY
```
public static final byte GET_KEY_PRIORITY
```
    See Also:
    Constant Field Values
  - PUT_KEY_PRIORITY
```
public static final byte PUT_KEY_PRIORITY
```
    See Also:
    Constant Field Values
  - ATOMIC_PRIORITY
```
public static final byte ATOMIC_PRIORITY
```
    See Also:
    Constant Field Values
  - GUI_PRIORITY
```
public static final byte GUI_PRIORITY
```
    See Also:
    Constant Field Values
  - MIN_HI_PRIORITY
```
public static final byte MIN_HI_PRIORITY
```
    See Also:
    Constant Field Values
  - MIN_PRIORITY
```
public static final byte MIN_PRIORITY
```
    See Also:
    Constant Field Values
  - LOW_PRIORITY_API_WORK
```
public static int LOW_PRIORITY_API_WORK
```
  - LOW_PRIORITY_API_WORK_CLASS
```
public static java.lang.String LOW_PRIORITY_API_WORK_CLASS
```
  - H2O_PORT
```
public static int H2O_PORT
```
  - API_PORT
```
public static int API_PORT
```
  - CLOUD_MULTICAST_SOCKET
```
public static java.net.MulticastSocket CLOUD_MULTICAST_SOCKET
```
  - CLOUD_MULTICAST_IF
```
public static java.net.NetworkInterface CLOUD_MULTICAST_IF
```
  - CLOUD_MULTICAST_GROUP
```
public static java.net.InetAddress CLOUD_MULTICAST_GROUP
```
  - CLOUD_MULTICAST_PORT
```
public static int CLOUD_MULTICAST_PORT
```
  - SELF
```
public static H2ONode SELF
```
    Myself, as a Node in the Cloud
  - SELF_ADDRESS
```
public static java.net.InetAddress SELF_ADDRESS
```
    IP address of this node used for communication with other nodes.
  - ICE_ROOT
```
public static java.net.URI ICE_ROOT
```
  - STATIC_H2OS
```
public static java.util.HashSet<H2ONode> STATIC_H2OS
```
  - CLUSTER_ID
```
public static final long CLUSTER_ID
```
  - CLOUD
```
public static volatile H2O CLOUD
```
  - _memary
```
public final H2ONode[] _memary
```
  - STORE
```
public static final water.nbhm.NonBlockingHashMap<Key,Value> STORE
```
- Method Detail
  - printHelp
```
public static void printHelp()
```
    Print help about command line arguments.
  - parseFailed
```
public static void parseFailed(java.lang.String message)
```
  - getMCM
```
public static ModelCacheManager getMCM()
```
  - setEmbeddedH2OConfig
```
public static void setEmbeddedH2OConfig(AbstractEmbeddedH2OConfig c)
```
    Register embedded H2O configuration object with H2O instance.
  - getEmbeddedH2OConfig
```
public static AbstractEmbeddedH2OConfig getEmbeddedH2OConfig()
```
  - notifyAboutCloudSize
```
public static void notifyAboutCloudSize(java.net.InetAddress ip,
                        int port,
                        int size)
```
    Tell the embedding software that this H2O instance belongs to a cloud of a certain size. This may be non-blocking.
    
    Parameters:
    ip - IP address this H2O can be reached at.
    port - Port this H2O can be reached at (for REST API and browser).
    size - Number of H2O instances in the cloud.
  - closeAll
```
public static void closeAll()
```
  - exit
```
public static void exit(int status)
```
    Notify embedding software instance H2O wants to exit. Shuts down a single Node.
    
    Parameters:
    status - H2O's requested process exit value.
  - shutdown
```
public static void shutdown(int status)
```
    Cluster shutdown itself by sending a shutdown UDP packet.
  - orderlyShutdown
```
public static int orderlyShutdown()
```
  - orderlyShutdown
```
public static int orderlyShutdown(int timeout)
```
  - requestShutdown
```
public static void requestShutdown()
```
  - getShutdownRequested
```
public static boolean getShutdownRequested()
```
  - haveInheritedLog4jConfiguration
```
public static boolean haveInheritedLog4jConfiguration()
```
  - configureLogging
```
public static void configureLogging()
```
  - registerExtensions
```
public static void registerExtensions()
```
    Register H2O extensions.
    Use reflection to find all classes that inherit from water.AbstractH2OExtension and call H2O.addExtension() for each.
  - addExtension
```
public static void addExtension(AbstractH2OExtension e)
```
  - getExtensions
```
public static java.util.ArrayList<AbstractH2OExtension> getExtensions()
```
  - registerRestApis
```
public static void registerRestApis(java.lang.String relativeResourcePath)
```
    Register REST API routes. Use reflection to find all classes that inherit from AbstractRegister and call the register() method for each.
    
    Parameters:
    relativeResourcePath - Relative path from running process working dir to find web resources.
  - addAboutEntry
```
public static void addAboutEntry(java.lang.String name,
                 java.lang.String value)
```
  - getAboutEntries
```
public static java.util.ArrayList<H2O.AboutEntry> getAboutEntries()
```
  - calcNextUniqueModelId
```
public static java.lang.String calcNextUniqueModelId(java.lang.String desc)
```
    Calculate a unique model id that includes User-Agent info (if it can be discovered). For the user agent info to be discovered, this needs to be called from a Jetty thread. This lets us distinguish models created from R vs. other front-ends, for example. At some future point, it could make sense to include a sessionId here. The algorithm is: descModel_[userAgentPrefixIfKnown_]cloudId_monotonicallyIncreasingInteger Right now because of the way the REST API works, a bunch of numbers are created and thrown away. So the values are monotonically increasing but not contiguous.
    
    Parameters:
    desc - Model description.
    
    Returns:
    The suffix.
  - unimpl
```
public static H2OIllegalArgumentException unimpl()
```
    Throw an exception that will cause the request to fail, but the cluster to continue.
    
    Returns:
    never returns
    See Also:
    fail(String, Throwable)
  - unimpl
```
public static H2OIllegalArgumentException unimpl(java.lang.String msg)
```
    Throw an exception that will cause the request to fail, but the cluster to continue.
    
    Returns:
    never returns
    See Also:
    unimpl(String), fail(String, Throwable)
  - fail
```
public static H2OFailException fail(java.lang.String msg,
                    java.lang.Throwable cause)
```
    H2O.fail is intended to be used in code where something should never happen, and if it does it's a coding error that needs to be addressed immediately. Examples are: AutoBuffer serialization for an object you're trying to serialize isn't available; there's a typing error on your schema; your switch statement didn't cover all the AstRoot subclasses available in Rapids.
    It should *not* be used when only the single request should fail, it should *only* be used if the error means that someone needs to go add some code right away.
    
    Parameters:
    msg - Message to Log.fatal()
    cause - Optional cause exception to Log.fatal()
    
    Returns:
    never returns; calls System.exit(-1)
  - fail
```
public static H2OFailException fail()
```
    Returns:
    never returns
    See Also:
    fail(String, Throwable)
  - fail
```
public static H2OFailException fail(java.lang.String msg)
```
    Returns:
    never returns
    See Also:
    fail(String, Throwable)
  - technote
```
public static java.lang.String technote(int number,
                        java.lang.String message)
```
    Return an error message with an accompanying URL to help the user get more detailed information.
    
    Parameters:
    number - H2O tech note number.
    message - Message to present to the user.
    
    Returns:
    A longer message including a URL.
  - technote
```
public static java.lang.String technote(int[] numbers,
                        java.lang.String message)
```
    Return an error message with an accompanying list of URLs to help the user get more detailed information.
    
    Parameters:
    numbers - H2O tech note numbers.
    message - Message to present to the user.
    
    Returns:
    A longer message including a list of URLs.
  - submitTask
```
public static <T extends H2O.H2OCountedCompleter> T submitTask(T task)
```
  - getIpPortString
```
public static java.lang.String getIpPortString()
```
    Returns:
    String of the form ipaddress:port
  - getURL
```
public static java.lang.String getURL(java.lang.String schema)
```
  - DEFAULT_ICE_ROOT
```
public static java.lang.String DEFAULT_ICE_ROOT()
```
  - DEFAULT_FLOW_DIR
```
public static java.lang.String DEFAULT_FLOW_DIR()
```
  - setJetty
```
public static void setJetty(JettyHTTPD value)
```
  - getJetty
```
public static JettyHTTPD getJetty()
```
  - register
```
public static void register(java.lang.String method_url,
            java.lang.Class<? extends Handler> hclass,
            java.lang.String method,
            java.lang.String apiName,
            java.lang.String summary)
```
  - registerResourceRoot
```
public static void registerResourceRoot(java.io.File f)
```
  - finalizeRegistration
```
public static void finalizeRegistration()
```
    Start the web service; disallow future URL registration. Blocks until the server is up.
  - size
```
public final int size()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - members
```
public H2ONode[] members()
```
  - free_mem
```
public long free_mem()
```
  - healthy
```
public boolean healthy()
```
  - waitForCloudSize
```
public static void waitForCloudSize(int x,
                    long ms)
```
  - getCloudSize
```
public static int getCloudSize()
```
  - joinOthers
```
public static void joinOthers()
```
  - putIfMatch
```
public static Value putIfMatch(Key key,
               Value val,
               Value old)
```
  - raw_remove
```
public static void raw_remove(Key key)
```
  - raw_clear
```
public static void raw_clear()
```
  - containsKey
```
public static boolean containsKey(Key key)
```
  - localKeySet
```
public static java.util.Set<Key> localKeySet()
```
  - store_size
```
public static int store_size()
```
  - STOREtoString
```
public static java.lang.String STOREtoString()
```
  - getPM
```
public static PersistManager getPM()
```
  - getNPS
```
public static NodePersistentStorage getNPS()
```
  - gc
```
public static void gc()
```
    Run System.gc() on every node in the H2O cluster. Having to call this manually from user code is a sign that something is wrong and a better heuristic is needed internally.
  - main
```
public static void main(java.lang.String[] args)
```
  - die
```
public static void die(java.lang.String s)
```

Class H2O

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_JKS_PASS

ARGS

GA

CLIENT_TYPE_GA_CUST_DIM

CLIENT_ID_GA_CUST_DIM

embeddedH2OConfig

ABV

START_TIME_MILLIS

NUMCPUS

PID

MAX_PRIORITY

ACK_ACK_PRIORITY

FETCH_ACK_PRIORITY

ACK_PRIORITY

DESERIAL_PRIORITY

INVALIDATE_PRIORITY

GET_KEY_PRIORITY

PUT_KEY_PRIORITY

ATOMIC_PRIORITY

GUI_PRIORITY

MIN_HI_PRIORITY

MIN_PRIORITY

LOW_PRIORITY_API_WORK

LOW_PRIORITY_API_WORK_CLASS

H2O_PORT

API_PORT

CLOUD_MULTICAST_SOCKET

CLOUD_MULTICAST_IF

CLOUD_MULTICAST_GROUP

CLOUD_MULTICAST_PORT

SELF

SELF_ADDRESS

ICE_ROOT

STATIC_H2OS

CLUSTER_ID

CLOUD

_memary

STORE

Method Detail

printHelp

parseFailed

getMCM

setEmbeddedH2OConfig

getEmbeddedH2OConfig

notifyAboutCloudSize

closeAll

exit

shutdown

orderlyShutdown

orderlyShutdown

requestShutdown

getShutdownRequested

haveInheritedLog4jConfiguration

configureLogging

registerExtensions

addExtension

getExtensions

registerRestApis

addAboutEntry

getAboutEntries

calcNextUniqueModelId

unimpl

unimpl

fail

fail

fail

technote

technote

submitTask

getIpPortString

getURL

DEFAULT_ICE_ROOT

DEFAULT_FLOW_DIR

setJetty