com.citrix.sdx.nitro.resource.config.mps

Class event

java.lang.Object

com.citrix.sdx.nitro.resource.base.base_resource

com.citrix.sdx.nitro.resource.config.mps.event

public class event
extends base_resource

Configuration for Event resource

Field Summary

Fields inherited from class com.citrix.sdx.nitro.resource.base.base_resource

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
event()

Method Summary

Methods

Modifier and Type	Method and Description
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of event resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of event resources.
static long	count(nitro_service service) Use this API to count the event resources configured on NetScaler SDX.
static event	delete(nitro_service client, event resource) Use this operation to delete events.
static event[]	delete(nitro_service client, event[] resources) Use this operation to delete events in bulk.
String	get_category() Category of Event
String	get_entity() Entity of Event
String	get_failureobj() Failure Object
static event[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of event resources.
static event[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of event resources.
String	get_history() History of the Event with same entity
String	get_id() Id is system generated key for all the events
String	get_message() Event Message
protected base_resource[]	get_nitro_bulk_response(nitro_service service, String response) Converts API response of bulk operation into object and returns the object array in case of get request.
protected base_resource[]	get_nitro_response(nitro_service service, String response) Converts API response into object and returns the object array in case of get request.
protected String	get_object_id() Returns the value of object identifier argument.
protected String	get_object_type() Gets the resource type.
String	get_operation_type() Operation Type
String	get_severity() Severity of Event
Integer	get_source_event_id() Internal Event ID used in the source device.
String	get_source() Source
Integer	get_timestamp() Event Time
Integer	get_trap_id() Last Octet of SNMP Trap OID
static event[]	get(nitro_service client) Use this operation to get events.
static event	get(nitro_service client, event resource) Use this operation to get events.
void	set_id(String id) Id is system generated key for all the events
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.base.base_resource

add_resource, add_resource, delete_bulk_request, delete_resource, get_resource, get_resource, get_resources, get_resources, getfiltered, perform_operation_bulk_request, perform_operation, perform_operation, perform_operation, resource_to_string, resource_to_string, update_bulk_request, update_resource, update_resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

event

public event()

Method Detail

get_object_type

protected String get_object_type()

Description copied from class: base_resource

Gets the resource type.

Overrides:

get_object_type in class base_resource

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Specified by:

get_object_id in class base_resource

get_source

public String get_source()

 Source
 

get_history

public String get_history()

 History of the Event with same entity
 

get_message

public String get_message()

 Event Message
 

get_trap_id

public Integer get_trap_id()

 Last Octet of SNMP Trap OID
 

get_entity

public String get_entity()

 Entity of Event
 

get_timestamp

public Integer get_timestamp()

 Event Time
 

get_operation_type

public String get_operation_type()

 Operation Type
 

set_id

public void set_id(String id)

 Id is system generated key for all the events
 

get_id

public String get_id()

 Id is system generated key for all the events
 

get_category

public String get_category()

 Category of Event
 

get_severity

public String get_severity()

 Severity of Event
 

get_failureobj

public String get_failureobj()

 Failure Object
 

get_source_event_id

public Integer get_source_event_id()

 Internal Event ID used in the source device.
 

delete

public static event delete(nitro_service client,
           event resource)
                    throws Exception

 Use this operation to delete events.
 

Throws:

Exception

delete

public static event[] delete(nitro_service client,
             event[] resources)
                      throws Exception

 Use this operation to delete events in bulk.
 

Throws:

Exception

get

public static event[] get(nitro_service client)
                   throws Exception

 Use this operation to get events.
 

Throws:

Exception

get

public static event get(nitro_service client,
        event resource)
                 throws Exception

Use this operation to get events.

Throws:

Exception

get_filtered

public static event[] get_filtered(nitro_service service,
                   String filter)
                            throws Exception

Use this API to fetch filtered set of event resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

get_filtered

public static event[] get_filtered(nitro_service service,
                   filtervalue[] filter)
                            throws Exception

Use this API to fetch filtered set of event resources. set the filter parameter values in filtervalue object.

Throws:

Exception

count

public static long count(nitro_service service)
                  throws Exception

Use this API to count the event resources configured on NetScaler SDX.

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  String filter)
                           throws Exception

Use this API to count the filtered set of event resources. filter string should be in JSON format.eg: "vm_state:DOWN,name:[a-z]+"

Throws:

Exception

count_filtered

public static long count_filtered(nitro_service service,
                  filtervalue[] filter)
                           throws Exception

Use this API to count the filtered set of event resources. set the filter parameter values in filtervalue object.

Throws:

Exception

get_nitro_response

protected base_resource[] get_nitro_response(nitro_service service,
                                 String response)
                                      throws Exception

 Converts API response into object and returns the object array in case of get request.
 

Specified by:

get_nitro_response in class base_resource

Throws:

Exception

get_nitro_bulk_response

protected base_resource[] get_nitro_bulk_response(nitro_service service,
                                      String response)
                                           throws Exception

 Converts API response of bulk operation into object and returns the object array in case of get request.
 

Specified by:

get_nitro_bulk_response in class base_resource

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class base_resource

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception