com.gpudb.protocol

Class ClearTableMonitorRequest

java.lang.Object

com.gpudb.protocol.ClearTableMonitorRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.clearTableMonitor(ClearTableMonitorRequest).

Deactivates a table monitor previously created with GPUdb.createTableMonitor(CreateTableMonitorRequest).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClearTableMonitorRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
ClearTableMonitorRequest() Constructs a ClearTableMonitorRequest object with default parameters.
ClearTableMonitorRequest(String topicId, Map<String,String> options) Constructs a ClearTableMonitorRequest 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.
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTopicId()
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.
ClearTableMonitorRequest	setOptions(Map<String,String> options)
ClearTableMonitorRequest	setTopicId(String topicId)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ClearTableMonitorRequest

public ClearTableMonitorRequest()

Constructs a ClearTableMonitorRequest object with default parameters.

ClearTableMonitorRequest

public ClearTableMonitorRequest(String topicId,
                                Map<String,String> options)

Constructs a ClearTableMonitorRequest object with the specified parameters.

Parameters:

topicId - The topic ID returned by GPUdb.createTableMonitor(CreateTableMonitorRequest).

options - Optional parameters.

• KEEP_AUTOGENERATED_SINK: If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CLEAR_ALL_REFERENCES: If true, all references that share the same topicId will be cleared. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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.

getTopicId

public String getTopicId()

Returns:

The topic ID returned by GPUdb.createTableMonitor(CreateTableMonitorRequest).

setTopicId

public ClearTableMonitorRequest setTopicId(String topicId)

Parameters:

topicId - The topic ID returned by GPUdb.createTableMonitor(CreateTableMonitorRequest).

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

• KEEP_AUTOGENERATED_SINK: If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CLEAR_ALL_REFERENCES: If true, all references that share the same topicId will be cleared. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

The default value is an empty Map.

setOptions

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

Parameters:

options - Optional parameters.

• KEEP_AUTOGENERATED_SINK: If true, the auto-generated datasink associated with this monitor, if there is one, will be retained for further use. If false, then the auto-generated sink will be dropped if there are no other monitors referencing it. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• CLEAR_ALL_REFERENCES: If true, all references that share the same topicId will be cleared. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.

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