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

Class inventory

java.lang.Object

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

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

public class inventory
extends base_resource

Configuration for Inventory resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
inventory()

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 inventory resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of inventory resources.
static long	count(nitro_service service) Use this API to count the inventory resources configured on NetScaler SDX.
String	get_act_id() Activity Id
String	get_device_ipaddress() Device IP Address
static inventory[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of inventory resources.
static inventory[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of inventory resources.
String	get_inventory_status() Status of inventory
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.
static inventory	get(nitro_service client, inventory resource) Use this operation to start inventory of a given device.
void	set_device_ipaddress(String device_ipaddress) Device 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

inventory

public inventory()

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_device_ipaddress

public void set_device_ipaddress(String device_ipaddress)

 Device IP Address
 

get_device_ipaddress

public String get_device_ipaddress()

 Device IP Address
 

get_act_id

public String get_act_id()

 Activity Id
 

get_inventory_status

public String get_inventory_status()

 Status of inventory
 

get

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

Use this operation to start inventory of a given device. All devices if device IP Address is not specified..

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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