Package com.gpudb.protocol

Class AdminSendAlertRequest

java.lang.Object

com.gpudb.protocol.AdminSendAlertRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.adminSendAlert.

Sends a user generated alert to the monitoring system.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdminSendAlertRequest.LogLevel	A set of string constants for the AdminSendAlertRequest parameter logLevel.

Constructor Summary

Constructors

Constructor	Description
AdminSendAlertRequest()	Constructs an AdminSendAlertRequest object with default parameters.
AdminSendAlertRequest(String message, String label, String logLevel, Map<String,String> options)	Constructs an AdminSendAlertRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	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	getLabel()	Label to add to alert message.
String	getLogLevel()	Alert message logging criteria.
String	getMessage()	Alert message body.
Map<String,String>	getOptions()	Optional parameters.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
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.
AdminSendAlertRequest	setLabel(String label)	Label to add to alert message.
AdminSendAlertRequest	setLogLevel(String logLevel)	Alert message logging criteria.
AdminSendAlertRequest	setMessage(String message)	Alert message body.
AdminSendAlertRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminSendAlertRequest

public AdminSendAlertRequest()

Constructs an AdminSendAlertRequest object with default parameters.

AdminSendAlertRequest

public AdminSendAlertRequest(String message,
                             String label,
                             String logLevel,
                             Map<String,String> options)

Constructs an AdminSendAlertRequest object with the specified parameters.

Parameters:

message - Alert message body. The default value is ''.

label - Label to add to alert message. The default value is ''.

logLevel - Alert message logging criteria. Supported values:

• FATAL
• ERROR
• WARN
• INFO
• DEBUG

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.

getMessage

public String getMessage()

Alert message body. The default value is ''.

Returns:

The current value of message.

setMessage

public AdminSendAlertRequest setMessage(String message)

Alert message body. The default value is ''.

Parameters:

message - The new value for message.

Returns:

this to mimic the builder pattern.

getLabel

public String getLabel()

Label to add to alert message. The default value is ''.

Returns:

The current value of label.

setLabel

public AdminSendAlertRequest setLabel(String label)

Label to add to alert message. The default value is ''.

Parameters:

label - The new value for label.

Returns:

this to mimic the builder pattern.

getLogLevel

public String getLogLevel()

Alert message logging criteria. Supported values:

• FATAL
• ERROR
• WARN
• INFO
• DEBUG

Returns:

The current value of logLevel.

setLogLevel

public AdminSendAlertRequest setLogLevel(String logLevel)

Alert message logging criteria. Supported values:

• FATAL
• ERROR
• WARN
• INFO
• DEBUG

Parameters:

logLevel - The new value for logLevel.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Optional parameters. The default value is an empty Map.

Returns:

The current value of options.

setOptions

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

Optional parameters. The default value is an empty Map.

Parameters:

options - The new value for options.

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