com.citrix.sdx.nitro.resource.config.br_broker

Class br_app_by_wan_volume

java.lang.Object

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

com.citrix.sdx.nitro.resource.config.br_broker.br_app_by_wan_volume

public class br_app_by_wan_volume
extends base_resource

Configuration for Top Apps by wan volume resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
br_app_by_wan_volume()

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 br_app_by_wan_volume resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of br_app_by_wan_volume resources.
static long	count(nitro_service service) Use this API to count the br_app_by_wan_volume resources configured on NetScaler SDX.
String	get_app_name() app name
static br_app_by_wan_volume[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of br_app_by_wan_volume resources.
static br_app_by_wan_volume[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of br_app_by_wan_volume resources.
String	get_id() Id is system generated key for all apps.
String	get_ip_address() IP Address
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_total_received_wan_volume() Total Received WAN Volume for an app in Mbps
Double	get_total_sent_wan_volume() Total Sent WAN Volume for an app in Mbps
Double	get_total_wan_volume() Total WAN volume for an app in Mbps
static br_app_by_wan_volume[]	get(nitro_service client) Use this operation to get top apps by WAN volume.
void	set_id(String id) Id is system generated key for all apps.
void	set_ip_address(String ip_address) IP Address
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

br_app_by_wan_volume

public br_app_by_wan_volume()

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_app_name

public String get_app_name()

 app name
 

get_total_wan_volume

public Double get_total_wan_volume()

 Total WAN volume for an app in Mbps
 

set_ip_address

public void set_ip_address(String ip_address)

 IP Address
 

get_ip_address

public String get_ip_address()

 IP Address
 

set_id

public void set_id(String id)

 Id is system generated key for all apps.
 

get_id

public String get_id()

 Id is system generated key for all apps.
 

get_total_received_wan_volume

public Double get_total_received_wan_volume()

 Total Received WAN Volume for an app in Mbps
 

get_total_sent_wan_volume

public Double get_total_sent_wan_volume()

 Total Sent WAN Volume for an app in Mbps
 

get

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

 Use this operation to get top apps by WAN volume.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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