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

Class syslog_params

java.lang.Object

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

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

public class syslog_params
extends base_resource

Configuration for Syslog Parameters 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_params()

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_params resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of syslog_params resources.
static long	count(nitro_service service) Use this API to count the syslog_params resources configured on NetScaler SDX.
String	get_date_format() Format of date to be added in the syslog message
static syslog_params[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of syslog_params resources.
static syslog_params[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of syslog_params resources.
String	get_id() Id is system generated key
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_timezone() Timezone to be used in the syslog message
static syslog_params[]	get(nitro_service client) Use this operation to get the syslog parameters.
static syslog_params	modify(nitro_service client, syslog_params resource) Use this operation to modify the syslog parameters.
static syslog_params[]	modify(nitro_service client, syslog_params[] resources) Use this operation to modify the syslog parameters in bulk.
void	set_date_format(String date_format) Format of date to be added in the syslog message
void	set_id(String id) Id is system generated key
void	set_timezone(String timezone) Timezone to be used in the syslog message
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_params

public syslog_params()

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_date_format

public void set_date_format(String date_format)

 Format of date to be added in the syslog message
 

get_date_format

public String get_date_format()

 Format of date to be added in the syslog message
 

set_timezone

public void set_timezone(String timezone)

 Timezone to be used in the syslog message
 

get_timezone

public String get_timezone()

 Timezone to be used in the syslog message
 

set_id

public void set_id(String id)

 Id is system generated key
 

get_id

public String get_id()

 Id is system generated key
 

get

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

 Use this operation to get the syslog parameters.
 

Throws:

Exception

modify

public static syslog_params modify(nitro_service client,
                   syslog_params resource)
                            throws Exception

 Use this operation to modify the syslog parameters.
 

Throws:

Exception

modify

public static syslog_params[] modify(nitro_service client,
                     syslog_params[] resources)
                              throws Exception

 Use this operation to modify the syslog parameters in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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