com.citrix.sdx.nitro.resource.config.br

Class br_vm_template

java.lang.Object

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

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

com.citrix.sdx.nitro.resource.config.br.br_vm_template

public class br_vm_template
extends vm_template

Configuration for BR VM Template 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_vm_template()

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_vm_template resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of br_vm_template resources.
static long	count(nitro_service service) Use this API to count the br_vm_template resources configured on NetScaler SDX.
static br_vm_template[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of br_vm_template resources.
static br_vm_template[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of br_vm_template resources.
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 br_vm_template[]	get(nitro_service client) Use this operation to get BR VM Template.
protected void	validate(String operationType) Performs generic data validation for the operation to be performed

Methods inherited from class com.citrix.sdx.nitro.resource.config.mps.vm_template

get_description, get_device_family, get_id, get_name, get_type, get_uuid, get, set_device_family, set_id, set_name, set_type

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_vm_template

public br_vm_template()

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 vm_template

Returns:

Resource Type.

get_object_id

protected String get_object_id()

Returns the value of object identifier argument.

Overrides:

get_object_id in class vm_template

get

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

 Use this operation to get BR VM Template.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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

Overrides:

get_nitro_response in class vm_template

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.
 

Overrides:

get_nitro_bulk_response in class vm_template

Throws:

Exception

validate

protected void validate(String operationType)
                 throws Exception

 Performs generic data validation for the operation to be performed
 

Overrides:

validate in class vm_template

Parameters:

operationType - : add,delete,modify,get etc.

Throws:

Exception