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

Class xen_health_disk

java.lang.Object

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

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

public class xen_health_disk
extends base_resource

Configuration for Disk IO Statistics 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_disk()

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_disk resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of xen_health_disk resources.
static long	count(nitro_service service) Use this API to count the xen_health_disk resources configured on NetScaler SDX.
Integer	get_bay_number() Bay number
Double	get_block_read_rate() Blocks read per second
Double	get_block_write_rate() Blocks written per second
static xen_health_disk[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of xen_health_disk resources.
static xen_health_disk[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of xen_health_disk resources.
String	get_host_ip_address() Host IP Address
String	get_name() Name of the Disk
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_size() Size of the disk (bytes)
Double	get_total_blocks_read() Total blocks read
Double	get_total_blocks_written() Total blocks written
Double	get_transaction_rate() Transactions per second
Double	get_utilized() Utilization of the disk (bytes)
static xen_health_disk[]	get(nitro_service client) Use this operation to get disk IO statistics.
static xen_health_disk	get(nitro_service client, xen_health_disk resource) Use this operation to get disk IO statistics.
void	set_bay_number(Integer bay_number) Bay number
void	set_block_read_rate(Double block_read_rate) Blocks read per second
void	set_block_write_rate(Double block_write_rate) Blocks written per second
void	set_host_ip_address(String host_ip_address) Host IP Address
void	set_name(String name) Name of the Disk
void	set_size(Double size) Size of the disk (bytes)
void	set_total_blocks_read(Double total_blocks_read) Total blocks read
void	set_total_blocks_written(Double total_blocks_written) Total blocks written
void	set_transaction_rate(Double transaction_rate) Transactions per second
void	set_utilized(Double utilized) Utilization of the disk (bytes)
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_disk

public xen_health_disk()

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_total_blocks_read

public void set_total_blocks_read(Double total_blocks_read)

 Total blocks read
 

get_total_blocks_read

public Double get_total_blocks_read()

 Total blocks read
 

set_name

public void set_name(String name)

 Name of the Disk
 

get_name

public String get_name()

 Name of the Disk
 

set_size

public void set_size(Double size)

 Size of the disk (bytes)
 

get_size

public Double get_size()

 Size of the disk (bytes)
 

set_total_blocks_written

public void set_total_blocks_written(Double total_blocks_written)

 Total blocks written
 

get_total_blocks_written

public Double get_total_blocks_written()

 Total blocks written
 

set_block_read_rate

public void set_block_read_rate(Double block_read_rate)

 Blocks read per second
 

get_block_read_rate

public Double get_block_read_rate()

 Blocks read per second
 

set_block_write_rate

public void set_block_write_rate(Double block_write_rate)

 Blocks written per second
 

get_block_write_rate

public Double get_block_write_rate()

 Blocks written per second
 

set_bay_number

public void set_bay_number(Integer bay_number)

 Bay number
 

get_bay_number

public Integer get_bay_number()

 Bay number
 

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_utilized

public void set_utilized(Double utilized)

 Utilization of the disk (bytes)
 

get_utilized

public Double get_utilized()

 Utilization of the disk (bytes)
 

set_transaction_rate

public void set_transaction_rate(Double transaction_rate)

 Transactions per second
 

get_transaction_rate

public Double get_transaction_rate()

 Transactions per second
 

get

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

 Use this operation to get disk IO statistics.
 

Throws:

Exception

get

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

Use this operation to get disk IO statistics.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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