com.gpudb.protocol

Class CreateTriggerByRangeRequest

java.lang.Object

com.gpudb.protocol.CreateTriggerByRangeRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class CreateTriggerByRangeRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.createTriggerByRange(CreateTriggerByRangeRequest).

Sets up a simple range trigger for a column_name for one or more tables. Once the trigger has been activated, any record added to the listed tables(s) via GPUdb.insertRecordsRaw(RawInsertRecordsRequest) with the chosen column_name's value falling within the specified range will trip the trigger. All such records will be queued at the trigger port (by default '9001' but able to be retrieved via GPUdb.showSystemStatus(ShowSystemStatusRequest)) for any listening client to collect. Active triggers can be cancelled by using the GPUdb.clearTrigger(ClearTriggerRequest) endpoint or by clearing all relevant tables.

The output returns the trigger handle as well as indicating success or failure of the trigger activation.

Constructor Summary

Constructors

Constructor and Description
CreateTriggerByRangeRequest() Constructs a CreateTriggerByRangeRequest object with default parameters.
CreateTriggerByRangeRequest(String requestId, List<String> tableNames, String columnName, double min, double max, Map<String,String> options) Constructs a CreateTriggerByRangeRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getColumnName()
double	getMax()
double	getMin()
Map<String,String>	getOptions()
String	getRequestId()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getTableNames()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
CreateTriggerByRangeRequest	setColumnName(String columnName)
CreateTriggerByRangeRequest	setMax(double max)
CreateTriggerByRangeRequest	setMin(double min)
CreateTriggerByRangeRequest	setOptions(Map<String,String> options)
CreateTriggerByRangeRequest	setRequestId(String requestId)
CreateTriggerByRangeRequest	setTableNames(List<String> tableNames)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateTriggerByRangeRequest

public CreateTriggerByRangeRequest()

Constructs a CreateTriggerByRangeRequest object with default parameters.

CreateTriggerByRangeRequest

public CreateTriggerByRangeRequest(String requestId,
                                   List<String> tableNames,
                                   String columnName,
                                   double min,
                                   double max,
                                   Map<String,String> options)

Constructs a CreateTriggerByRangeRequest object with the specified parameters.

Parameters:

requestId - User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

tableNames - Tables on which the trigger will be active.

columnName - Name of a numeric column_name on which the trigger is activated.

min - The lower bound (inclusive) for the trigger range.

max - The upper bound (inclusive) for the trigger range.

options - Optional parameters. The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getRequestId

public String getRequestId()

Returns:

User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

setRequestId

public CreateTriggerByRangeRequest setRequestId(String requestId)

Parameters:

requestId - User-created ID for the trigger. The ID can be alphanumeric, contain symbols, and must contain at least one character.

Returns:

this to mimic the builder pattern.

getTableNames

public List<String> getTableNames()

Returns:

Tables on which the trigger will be active.

setTableNames

public CreateTriggerByRangeRequest setTableNames(List<String> tableNames)

Parameters:

tableNames - Tables on which the trigger will be active.

Returns:

this to mimic the builder pattern.

getColumnName

public String getColumnName()

Returns:

Name of a numeric column_name on which the trigger is activated.

setColumnName

public CreateTriggerByRangeRequest setColumnName(String columnName)

Parameters:

columnName - Name of a numeric column_name on which the trigger is activated.

Returns:

this to mimic the builder pattern.

getMin

public double getMin()

Returns:

The lower bound (inclusive) for the trigger range.

setMin

public CreateTriggerByRangeRequest setMin(double min)

Parameters:

min - The lower bound (inclusive) for the trigger range.

Returns:

this to mimic the builder pattern.

getMax

public double getMax()

Returns:

The upper bound (inclusive) for the trigger range.

setMax

public CreateTriggerByRangeRequest setMax(double max)

Parameters:

max - The upper bound (inclusive) for the trigger range.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters. The default value is an empty Map.

setOptions

public CreateTriggerByRangeRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters. The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object