com.gpudb.protocol

Class AdminShowAlertsRequest

java.lang.Object

com.gpudb.protocol.AdminShowAlertsRequest

All Implemented Interfaces:

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

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

A set of parameters for GPUdb.adminShowAlerts(AdminShowAlertsRequest).

Retrieves a list of the most recent alerts generated. The number of alerts to retrieve is specified in this request. Returns lists of alert data, earliest to latest

Constructor Summary

Constructors

Constructor and Description
AdminShowAlertsRequest() Constructs an AdminShowAlertsRequest object with default parameters.
AdminShowAlertsRequest(int numAlerts, Map<String,String> options) Constructs an AdminShowAlertsRequest 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.
int	getNumAlerts()
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.
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.
AdminShowAlertsRequest	setNumAlerts(int numAlerts)
AdminShowAlertsRequest	setOptions(Map<String,String> options)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminShowAlertsRequest

public AdminShowAlertsRequest()

Constructs an AdminShowAlertsRequest object with default parameters.

AdminShowAlertsRequest

public AdminShowAlertsRequest(int numAlerts,
                              Map<String,String> options)

Constructs an AdminShowAlertsRequest object with the specified parameters.

Parameters:

numAlerts - Number of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.

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.

getNumAlerts

public int getNumAlerts()

Returns:

Number of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.

setNumAlerts

public AdminShowAlertsRequest setNumAlerts(int numAlerts)

Parameters:

numAlerts - Number of most recent alerts to request. The response will return numAlerts alerts, or less if there are less in the system. A value of 0 returns all stored alerts.

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 AdminShowAlertsRequest 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