com.citrix.sdx.nitro.resource.config.xen

Class xen_health_resource

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.xen.xen_health_resource

Direct Known Subclasses:

xen_health_resource_hw, xen_health_resource_sw

public class xen_health_resource
extends base_resource

Configuration for Xen Health Resource resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
xen_health_resource()

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 xen_health_resource resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of xen_health_resource resources.
static long	count(nitro_service service) Use this API to count the xen_health_resource resources configured on NetScaler SDX.
String	get_current_value() Current value of the resource
String	get_expected_value() Expected value of the resource
static xen_health_resource[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of xen_health_resource resources.
static xen_health_resource[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of xen_health_resource resources.
String	get_host_ip_address() Host IP Address
String	get_name() Resource 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.
String	get_status() Health status of the resource - OK/ERROR
String	get_unit() Measurement unit for the resource
static xen_health_resource[]	get(nitro_service client) Use this operation to get the current values of the resources.
static xen_health_resource	get(nitro_service client, xen_health_resource resource) Use this operation to get the current values of the resources.
void	set_current_value(String current_value) Current value of the resource
void	set_expected_value(String expected_value) Expected value of the resource
void	set_host_ip_address(String host_ip_address) Host IP Address
void	set_name(String name) Resource name
void	set_status(String status) Health status of the resource - OK/ERROR
void	set_unit(String unit) Measurement unit for the resource
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

xen_health_resource

public xen_health_resource()

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_expected_value

public void set_expected_value(String expected_value)

 Expected value of the resource
 

get_expected_value

public String get_expected_value()

 Expected value of the resource
 

set_unit

public void set_unit(String unit)

 Measurement unit for the resource
 

get_unit

public String get_unit()

 Measurement unit for the resource
 

set_current_value

public void set_current_value(String current_value)

 Current value of the resource
 

get_current_value

public String get_current_value()

 Current value of the resource
 

set_status

public void set_status(String status)

 Health status of the resource - OK/ERROR
 

get_status

public String get_status()

 Health status of the resource - OK/ERROR
 

set_host_ip_address

public void set_host_ip_address(String host_ip_address)

 Host IP Address
 

get_host_ip_address

public String get_host_ip_address()

 Host IP Address
 

set_name

public void set_name(String name)

 Resource name
 

get_name

public String get_name()

 Resource name
 

get

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

 Use this operation to get the current values of the resources.
 

Throws:

Exception

get

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

Use this operation to get the current values of the resources.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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