Confluo  0.1.0
Public Member Functions | List of all members
confluo.rpc.RpcClient Class Reference

Public Member Functions

 RpcClient (String host, int port) throws TException
 
void close () throws TException
 
void disconnect () throws TException
 
void createAtomicMultilog (String name, Schema schema, rpc_storage_mode storageMode) throws TException
 
void createAtomicMultilog (String name, String schema, rpc_storage_mode storageMode) throws TException
 
void setCurrentAtomicMultilog (String name) throws TException
 
void removeAtomicMultilog () throws TException
 
void addIndex (String fieldName, double bucketSize) throws TException
 
void removeIndex (String fieldName) throws TException
 
void addFilter (String filterName, String filterExpr) throws TException
 
void removeFilter (String filterName) throws TException
 
void addAggregate (String aggregateName, String filterName, String aggregateExpr) throws TException
 
void removeAggregate (String aggregateName) throws TException
 
void installTrigger (String triggerName, String triggerExpr) throws TException
 
void removeTrigger (String triggerName) throws TException
 
RecordBatchBuilder getBatchBuilder ()
 
long appendRaw (ByteBuffer record) throws TException
 
long append (List< String > record) throws TException
 
long append (String... record) throws TException
 
ByteBuffer readRaw (long offset) throws TException
 
Record read (long offset) throws TException
 
String getAggregate (String aggregateName, long beginMs, long endMs) throws TException
 
RecordStream executeFilter (String filterExpr) throws TException
 
RecordStream queryFilter (String filterName, long beginMs, long endMs, String filterExpr) throws TException
 
AlertStream getAlerts (long beginMs, long endMs, String triggerName) throws TException
 
long numRecords () throws TException
 

Detailed Description

Client for Confluo through RPC

Constructor & Destructor Documentation

◆ RpcClient()

confluo.rpc.RpcClient.RpcClient ( String  host,
int  port 
) throws TException
inline

Initializes the rpc client to the specified host and port

Parameters
hostThe host for the client
portThe port number to communicate through
Exceptions
TExceptionCannot connect to host

Member Function Documentation

◆ addAggregate()

void confluo.rpc.RpcClient.addAggregate ( String  aggregateName,
String  filterName,
String  aggregateExpr 
) throws TException
inline

Adds an aggregate to the atomic multilog

Parameters
aggregateNameThe name of the aggregate
filterNameThe name of the filter
aggregateExprThe aggregate expression
Exceptions
TExceptionCannot add the aggregate

◆ addFilter()

void confluo.rpc.RpcClient.addFilter ( String  filterName,
String  filterExpr 
) throws TException
inline

Adds a filter to the atomic multilog

Parameters
filterNameThe name of the filter
filterExprThe filter expression
Exceptions
TExceptionCannot add filter

◆ addIndex()

void confluo.rpc.RpcClient.addIndex ( String  fieldName,
double  bucketSize 
) throws TException
inline

Adds an index to the atomic multilog

Parameters
fieldNameThe name of the associated field
bucketSizeThe bucket in the multilog to add the index
Exceptions
TExceptionCannot add the index

◆ append() [1/2]

long confluo.rpc.RpcClient.append ( List< String >  record) throws TException
inline

Writes a record to the atomic multilog

Parameters
recordThe record to write
Returns
The offset into the log where the record is written.
Exceptions
TExceptionCannot append the record

◆ append() [2/2]

long confluo.rpc.RpcClient.append ( String...  record) throws TException
inline

Writes a record to the atomic multilog

Parameters
recordThe record to write
Returns
The offset into the log where the record is written.
Exceptions
TExceptionCannot append the record

◆ appendRaw()

long confluo.rpc.RpcClient.appendRaw ( ByteBuffer  record) throws TException
inline

Writes a record to the atomic multilog

Parameters
recordThe record to write
Returns
The offset into the log where the record is written.
Exceptions
TExceptionCannot append the record

◆ close()

void confluo.rpc.RpcClient.close ( ) throws TException
inline

Closes the rpc client

Exceptions
TExceptionCannot disconnect

◆ createAtomicMultilog() [1/2]

void confluo.rpc.RpcClient.createAtomicMultilog ( String  name,
Schema  schema,
rpc_storage_mode  storageMode 
) throws TException
inline

Creates an atomic multilog for this client

Parameters
nameThe name of the atomic multilog to create
schemaThe schema for the atomic multilog
storageModeThe mode for storage
Exceptions
TExceptionCannot create the atomic multilog

◆ createAtomicMultilog() [2/2]

void confluo.rpc.RpcClient.createAtomicMultilog ( String  name,
String  schema,
rpc_storage_mode  storageMode 
) throws TException
inline

Creates an atomic multilog for this client

Parameters
nameThe name of the atomic multilog to create
schemaThe schema for the atomic multilog
storageModeThe mode for storage
Exceptions
TExceptionCannot create the atomic multilog

◆ disconnect()

void confluo.rpc.RpcClient.disconnect ( ) throws TException
inline

Disconnects the rpc client from the host and port

Exceptions
TExceptionCannot disconnect

◆ executeFilter()

RecordStream confluo.rpc.RpcClient.executeFilter ( String  filterExpr) throws TException
inline

Executes a specified filter

Parameters
filterExprThe filter expression
Returns
Record stream containing the data
Exceptions
TExceptionCannot execute the filter

◆ getAggregate()

String confluo.rpc.RpcClient.getAggregate ( String  aggregateName,
long  beginMs,
long  endMs 
) throws TException
inline

Gets an aggregate from the atomic multilog

Parameters
aggregateNameThe name of the aggregate
beginMsThe beginning time in milliseconds
endMsThe end time in milliseconds
Returns
The aggregate
Exceptions
TExceptionCannot get the aggregate

◆ getAlerts()

AlertStream confluo.rpc.RpcClient.getAlerts ( long  beginMs,
long  endMs,
String  triggerName 
) throws TException
inline

Gets the alerts

Parameters
beginMsThe beginning time in milliseconds
endMsThe end time in milliseconds
triggerNameThe name of the trigger
Returns
A stream of alerts
Exceptions
TExceptionCannot get the alerts

◆ getBatchBuilder()

RecordBatchBuilder confluo.rpc.RpcClient.getBatchBuilder ( )
inline

Gets a new record batch builder

Returns
The RPC record batch builder

◆ installTrigger()

void confluo.rpc.RpcClient.installTrigger ( String  triggerName,
String  triggerExpr 
) throws TException
inline

Adds a trigger to the atomic multilog

Parameters
triggerNameThe name of the trigger to add
triggerExprThe trigger expression
Exceptions
TExceptionCannot add the trigger

◆ numRecords()

long confluo.rpc.RpcClient.numRecords ( ) throws TException
inline

Gets the number of records in the atomic multilog

Returns
The number of records
Exceptions
TExceptionCannot get the number of records

◆ queryFilter()

RecordStream confluo.rpc.RpcClient.queryFilter ( String  filterName,
long  beginMs,
long  endMs,
String  filterExpr 
) throws TException
inline

Queries a filter

Parameters
filterNameThe name of the filter
beginMsThe beginning time in milliseconds
endMsThe end time in milliseconds
filterExprThe filter expression
Returns
A record stream containing the results of the filter
Exceptions
TExceptionCannot query the filter

◆ readRaw()

ByteBuffer confluo.rpc.RpcClient.readRaw ( long  offset) throws TException
inline

Reads data from a specified offset

Parameters
offsetThe offset from the log to readRaw from
Returns
The data get the offset
Exceptions
TExceptionCannot read the record

◆ removeAggregate()

void confluo.rpc.RpcClient.removeAggregate ( String  aggregateName) throws TException
inline

Removes an aggregate from the atomic multilog

Parameters
aggregateNameThe name of the aggregate
Exceptions
TExceptionCannot remove the aggregate

◆ removeAtomicMultilog()

void confluo.rpc.RpcClient.removeAtomicMultilog ( ) throws TException
inline

Removes an atomic multilog from the client

Exceptions
TExceptionCannot remove the atomic multilog

◆ removeFilter()

void confluo.rpc.RpcClient.removeFilter ( String  filterName) throws TException
inline

Removes a filter from the atomic multilog

Parameters
filterNameThe name of the filter
Exceptions
TExceptionCannot remove the filter

◆ removeIndex()

void confluo.rpc.RpcClient.removeIndex ( String  fieldName) throws TException
inline

Removes an index from the atomic multilog

Parameters
fieldNameThe name of the associated field
Exceptions
TExceptionCannot remove the index

◆ removeTrigger()

void confluo.rpc.RpcClient.removeTrigger ( String  triggerName) throws TException
inline

Removes a trigger from the atomic multilog

Parameters
triggerNameThe name of the trigger
Exceptions
TExceptionCannot remove the trigger

◆ setCurrentAtomicMultilog()

void confluo.rpc.RpcClient.setCurrentAtomicMultilog ( String  name) throws TException
inline

Sets the atomic multilog to the desired atomic multilog

Parameters
nameThe name of atomic multilog to set the current atomic multilog to
Exceptions
TExceptionCannot set the atomic multilog

The documentation for this class was generated from the following file: