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

Class syslog_ui_cmd

java.lang.Object

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

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

public class syslog_ui_cmd
extends base_resource

Configuration for Syslog UI command table resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
syslog_ui_cmd()

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 syslog_ui_cmd resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of syslog_ui_cmd resources.
static long	count(nitro_service service) Use this API to count the syslog_ui_cmd resources configured on NetScaler SDX.
static syslog_ui_cmd	delete(nitro_service client, syslog_ui_cmd resource) Use this operation to delete ui cmd syslog message details..
static syslog_ui_cmd[]	delete(nitro_service client, syslog_ui_cmd[] resources) Use this operation to delete ui cmd syslog message details.
String	get_clientip() Client ip address.
String	get_command() Command being executed.
Double	get_datarecord_rx_time() Transaction Time when this was received.
Boolean	get_decoded() Whether this was decoded.
Double	get_exporter_id() Exporter ID
static syslog_ui_cmd[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of syslog_ui_cmd resources.
static syslog_ui_cmd[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of syslog_ui_cmd resources.
String	get_group_name() Group Name.
String	get_hostname() Host Name.
String	get_id() Id is system generated key for all the syslog ui cmd record.
String	get_module() Module Name.
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.
Double	get_priority() priority
String	get_process_name() Process Name.
Double	get_sequence_no() Sequence no.
String	get_status() Status of the message.
String	get_syslog_msg() Syslog original Message.
Double	get_timestamp() timestamp
String	get_type() Type Name.
String	get_username() User name.
static syslog_ui_cmd[]	get(nitro_service client) Report for syslog ui command by this Collector.
void	set_clientip(String clientip) Client ip address.
void	set_command(String command) Command being executed.
void	set_datarecord_rx_time(Double datarecord_rx_time) Transaction Time when this was received.
void	set_decoded(Boolean decoded) Whether this was decoded.
void	set_exporter_id(Double exporter_id) Exporter ID
void	set_group_name(String group_name) Group Name.
void	set_hostname(String hostname) Host Name.
void	set_id(String id) Id is system generated key for all the syslog ui cmd record.
void	set_module(String module) Module Name.
void	set_priority(Double priority) priority
void	set_process_name(String process_name) Process Name.
void	set_sequence_no(Double sequence_no) Sequence no.
void	set_status(String status) Status of the message.
void	set_syslog_msg(String syslog_msg) Syslog original Message.
void	set_timestamp(Double timestamp) timestamp
void	set_type(String type) Type Name.
void	set_username(String username) User name.
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

syslog_ui_cmd

public syslog_ui_cmd()

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

set_priority

public void set_priority(Double priority)

 priority
 

get_priority

public Double get_priority()

 priority
 

set_sequence_no

public void set_sequence_no(Double sequence_no)

 Sequence no.
 

get_sequence_no

public Double get_sequence_no()

 Sequence no.
 

set_group_name

public void set_group_name(String group_name)

 Group Name.
 

get_group_name

public String get_group_name()

 Group Name.
 

set_status

public void set_status(String status)

 Status of the message.
 

get_status

public String get_status()

 Status of the message.
 

set_decoded

public void set_decoded(Boolean decoded)

 Whether this was decoded.
 

get_decoded

public Boolean get_decoded()

 Whether this was decoded.
 

set_hostname

public void set_hostname(String hostname)

 Host Name.
 

get_hostname

public String get_hostname()

 Host Name.
 

set_datarecord_rx_time

public void set_datarecord_rx_time(Double datarecord_rx_time)

 Transaction Time when this was received.
 

get_datarecord_rx_time

public Double get_datarecord_rx_time()

 Transaction Time when this was received.
 

set_username

public void set_username(String username)

 User name.
 

get_username

public String get_username()

 User name.
 

set_exporter_id

public void set_exporter_id(Double exporter_id)

 Exporter ID
 

get_exporter_id

public Double get_exporter_id()

 Exporter ID
 

set_timestamp

public void set_timestamp(Double timestamp)

 timestamp
 

get_timestamp

public Double get_timestamp()

 timestamp
 

set_process_name

public void set_process_name(String process_name)

 Process Name.
 

get_process_name

public String get_process_name()

 Process Name.
 

set_id

public void set_id(String id)

 Id is system generated key for all the syslog ui cmd record.
 

get_id

public String get_id()

 Id is system generated key for all the syslog ui cmd record.
 

set_type

public void set_type(String type)

 Type Name.
 

get_type

public String get_type()

 Type Name.
 

set_syslog_msg

public void set_syslog_msg(String syslog_msg)

 Syslog original Message.
 

get_syslog_msg

public String get_syslog_msg()

 Syslog original Message.
 

set_command

public void set_command(String command)

 Command being executed.
 

get_command

public String get_command()

 Command being executed.
 

set_clientip

public void set_clientip(String clientip)

 Client ip address.
 

get_clientip

public String get_clientip()

 Client ip address.
 

set_module

public void set_module(String module)

 Module Name.
 

get_module

public String get_module()

 Module Name.
 

delete

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

 Use this operation to delete ui cmd syslog message details..
 

Throws:

Exception

delete

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

 Use this operation to delete ui cmd syslog message details. in bulk.
 

Throws:

Exception

get

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

 Report for syslog ui command by this Collector.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

Use this API to fetch filtered set of syslog_ui_cmd 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 syslog_ui_cmd 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 syslog_ui_cmd 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 syslog_ui_cmd 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