CommandLineParser (Kudu 0.8.0 API)

java.lang.Object
- org.kududb.mapreduce.CommandLineParser

```
@InterfaceAudience.Public
@InterfaceStability.Unstable
public class CommandLineParser
extends Object
```
Utility class that manages common configurations to all MR jobs. For example, any job that uses {#KuduTableMapReduceUtil} to setup an input or output format and that has parsed the command line arguments with GenericOptionsParser can simply be passed: -Dmaster.address=ADDRESS in order to specify where the master is. Use getHelpSnippet() to provide usage text for the configurations managed by this class.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADMIN_OPERATION_TIMEOUT_MS_KEY`
`static String`	`MASTER_ADDRESSES_DEFAULT`
`static String`	`MASTER_ADDRESSES_KEY`
`static int`	`NUM_REPLICAS_DEFAULT`
`static String`	`NUM_REPLICAS_KEY`
`static long`	`OPERATION_TIMEOUT_MS_DEFAULT`
`static String`	`OPERATION_TIMEOUT_MS_KEY`
`static long`	`SOCKET_READ_TIMEOUT_MS_DEFAULT`
`static String`	`SOCKET_READ_TIMEOUT_MS_KEY`

Constructor Summary

Constructors
Constructor and Description
`CommandLineParser(org.apache.hadoop.conf.Configuration conf)` Constructor that uses a Configuration that has already been through `GenericOptionsParser`'s command line parsing.

Method Summary

Methods
Modifier and Type	Method and Description
`long`	`getAdminOperationTimeoutMs()` Get the configured timeout for admin operations.
`AsyncKuduClient`	`getAsyncClient()` Get an async client connected to the configured Master(s).
`KuduClient`	`getClient()` Get a client connected to the configured Master(s).
`static String`	`getHelpSnippet()` This method returns a single multi-line string that contains the help snippet to append to the tail of a usage() or help() type of method.
`String`	`getMasterAddresses()` Get the configured master's config.
`int`	`getNumReplicas()` Get the number of replicas to use when configuring a new table.
`long`	`getOperationTimeoutMs()` Get the configured timeout for operations on sessions and scanners.
`long`	`getSocketReadTimeoutMs()` Get the configured timeout for socket reads.

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

- Field Detail
  - MASTER_ADDRESSES_KEY
```
public static final String MASTER_ADDRESSES_KEY
```
    See Also:
    Constant Field Values
  - MASTER_ADDRESSES_DEFAULT
```
public static final String MASTER_ADDRESSES_DEFAULT
```
    See Also:
    Constant Field Values
  - OPERATION_TIMEOUT_MS_KEY
```
public static final String OPERATION_TIMEOUT_MS_KEY
```
    See Also:
    Constant Field Values
  - OPERATION_TIMEOUT_MS_DEFAULT
```
public static final long OPERATION_TIMEOUT_MS_DEFAULT
```
    See Also:
    Constant Field Values
  - ADMIN_OPERATION_TIMEOUT_MS_KEY
```
public static final String ADMIN_OPERATION_TIMEOUT_MS_KEY
```
    See Also:
    Constant Field Values
  - SOCKET_READ_TIMEOUT_MS_KEY
```
public static final String SOCKET_READ_TIMEOUT_MS_KEY
```
    See Also:
    Constant Field Values
  - SOCKET_READ_TIMEOUT_MS_DEFAULT
```
public static final long SOCKET_READ_TIMEOUT_MS_DEFAULT
```
    See Also:
    Constant Field Values
  - NUM_REPLICAS_KEY
```
public static final String NUM_REPLICAS_KEY
```
    See Also:
    Constant Field Values
  - NUM_REPLICAS_DEFAULT
```
public static final int NUM_REPLICAS_DEFAULT
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CommandLineParser
```
public CommandLineParser(org.apache.hadoop.conf.Configuration conf)
```
    Constructor that uses a Configuration that has already been through GenericOptionsParser's command line parsing.
    
    Parameters:
    conf - the configuration from which job configurations will be extracted
- Method Detail
  - getMasterAddresses
```
public String getMasterAddresses()
```
    Get the configured master's config.
    
    Returns:
    a string that contains the passed config, or the default value
  - getOperationTimeoutMs
```
public long getOperationTimeoutMs()
```
    Get the configured timeout for operations on sessions and scanners.
    
    Returns:
    a long that represents the passed timeout, or the default value
  - getAdminOperationTimeoutMs
```
public long getAdminOperationTimeoutMs()
```
    Get the configured timeout for admin operations.
    
    Returns:
    a long that represents the passed timeout, or the default value
  - getSocketReadTimeoutMs
```
public long getSocketReadTimeoutMs()
```
    Get the configured timeout for socket reads.
    
    Returns:
    a long that represents the passed timeout, or the default value
  - getNumReplicas
```
public int getNumReplicas()
```
    Get the number of replicas to use when configuring a new table.
    
    Returns:
    an int that represents the passed number of replicas to use, or the default value.
  - getAsyncClient
```
public AsyncKuduClient getAsyncClient()
```
    Get an async client connected to the configured Master(s).
    
    Returns:
    an async kudu client
  - getClient
```
public KuduClient getClient()
```
    Get a client connected to the configured Master(s).
    
    Returns:
    a kudu client
  - getHelpSnippet
```
public static String getHelpSnippet()
```
    This method returns a single multi-line string that contains the help snippet to append to the tail of a usage() or help() type of method.
    
    Returns:
    a string with all the available configurations and their defaults

Class CommandLineParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MASTER_ADDRESSES_KEY

MASTER_ADDRESSES_DEFAULT

OPERATION_TIMEOUT_MS_KEY

OPERATION_TIMEOUT_MS_DEFAULT

ADMIN_OPERATION_TIMEOUT_MS_KEY

SOCKET_READ_TIMEOUT_MS_KEY

SOCKET_READ_TIMEOUT_MS_DEFAULT

NUM_REPLICAS_KEY

NUM_REPLICAS_DEFAULT

Constructor Detail

CommandLineParser

Method Detail

getMasterAddresses

getOperationTimeoutMs

getAdminOperationTimeoutMs

getSocketReadTimeoutMs

getNumReplicas

getAsyncClient

getClient

getHelpSnippet