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

Class snmp_view

java.lang.Object

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

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

public class snmp_view
extends base_resource

Configuration for SNMP view resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
snmp_view()

Method Summary

Methods

Modifier and Type	Method and Description
static snmp_view	add(nitro_service client, snmp_view resource) Use this operation to add SNMP View.
static snmp_view[]	add(nitro_service client, snmp_view[] resources) Use this operation to add SNMP View in bulk.
static long	count_filtered(nitro_service service, filtervalue[] filter) Use this API to count the filtered set of snmp_view resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of snmp_view resources.
static long	count(nitro_service service) Use this API to count the snmp_view resources configured on NetScaler SDX.
static snmp_view	delete(nitro_service client, snmp_view resource) Use this operation to delete SNMP View.
static snmp_view[]	delete(nitro_service client, snmp_view[] resources) Use this operation to delete SNMP View in bulk.
static snmp_view[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of snmp_view resources.
static snmp_view[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of snmp_view resources.
String	get_name() Name of SNMP view
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_subtree() Subtree associated with the SNMP view
String	get_type_str() Type value in string format.(Only for GET request)
Boolean	get_type() Include or Exclude the associated subtree .
static snmp_view[]	get(nitro_service client) Use this operation to get SNMP View details.
static snmp_view	get(nitro_service client, snmp_view resource) Use this operation to get SNMP View details.
void	set_name(String name) Name of SNMP view
void	set_subtree(String subtree) Subtree associated with the SNMP view
void	set_type_str(String type_str) Type value in string format.(Only for GET request)
void	set_type(Boolean type) Include or Exclude the associated subtree .
static snmp_view	update(nitro_service client, snmp_view resource) Use this operation to modify SNMP View.
static snmp_view[]	update(nitro_service client, snmp_view[] resources) Use this operation to modify SNMP View in bulk.
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

snmp_view

public snmp_view()

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_subtree

public void set_subtree(String subtree)

 Subtree associated with the SNMP view
 

get_subtree

public String get_subtree()

 Subtree associated with the SNMP view
 

set_name

public void set_name(String name)

 Name of SNMP view
 

get_name

public String get_name()

 Name of SNMP view
 

set_type

public void set_type(Boolean type)

 Include or Exclude the associated subtree . Values. true:Include, false: Exclude
 

get_type

public Boolean get_type()

 Include or Exclude the associated subtree . Values. true:Include, false: Exclude
 

set_type_str

public void set_type_str(String type_str)

 Type value in string format.(Only for GET request)
 

get_type_str

public String get_type_str()

 Type value in string format.(Only for GET request)
 

add

public static snmp_view add(nitro_service client,
            snmp_view resource)
                     throws Exception

 Use this operation to add SNMP View.
 

Throws:

Exception

add

public static snmp_view[] add(nitro_service client,
              snmp_view[] resources)
                       throws Exception

 Use this operation to add SNMP View in bulk.
 

Throws:

Exception

delete

public static snmp_view delete(nitro_service client,
               snmp_view resource)
                        throws Exception

 Use this operation to delete SNMP View.
 

Throws:

Exception

delete

public static snmp_view[] delete(nitro_service client,
                 snmp_view[] resources)
                          throws Exception

 Use this operation to delete SNMP View in bulk.
 

Throws:

Exception

get

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

 Use this operation to get SNMP View details.
 

Throws:

Exception

get

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

Use this operation to get SNMP View details.

Throws:

Exception

update

public static snmp_view update(nitro_service client,
               snmp_view resource)
                        throws Exception

 Use this operation to modify SNMP View.
 

Throws:

Exception

update

public static snmp_view[] update(nitro_service client,
                 snmp_view[] resources)
                          throws Exception

 Use this operation to modify SNMP View in bulk.
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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