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

Class backup_file

java.lang.Object

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

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

public class backup_file
extends base_resource

Configuration for Backup files resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
backup_file()

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 backup_file resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of backup_file resources.
static long	count(nitro_service service) Use this API to count the backup_file resources configured on NetScaler SDX.
static backup_file	delete(nitro_service client, backup_file resource) Use this operation to delete backup file.
static backup_file[]	delete(nitro_service client, backup_file[] resources) Use this operation to delete backup file in bulk.
String	get_file_last_modified() Last Modified
String	get_file_name() File Name
Integer	get_file_size() file_size
static backup_file[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of backup_file resources.
static backup_file[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of backup_file 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 backup_file[]	get(nitro_service client) Use this operation to get backup file.
static backup_file	get(nitro_service client, backup_file resource) Use this operation to get backup file.
void	set_file_name(String file_name) File Name
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

backup_file

public backup_file()

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_file_size

public Integer get_file_size()

 file_size
 

set_file_name

public void set_file_name(String file_name)

 File Name
 

get_file_name

public String get_file_name()

 File Name
 

get_file_last_modified

public String get_file_last_modified()

 Last Modified
 

delete

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

 Use this operation to delete backup file.
 

Throws:

Exception

delete

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

 Use this operation to delete backup file in bulk.
 

Throws:

Exception

get

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

 Use this operation to get backup file.
 

Throws:

Exception

get

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

Use this operation to get backup file.

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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