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

Class sent_sms

java.lang.Object

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

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

public class sent_sms
extends base_resource

Configuration for Sent sms record item keeping. resource

Field Summary

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

SESSION_NOT_EXISTS

Constructor Summary

Constructors

Constructor and Description
sent_sms()

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 sent_sms resources.
static long	count_filtered(nitro_service service, String filter) Use this API to count the filtered set of sent_sms resources.
static long	count(nitro_service service) Use this API to count the sent_sms resources configured on NetScaler SDX.
static sent_sms	delete(nitro_service client, sent_sms resource) Use this operation to delete sent sms details..
static sent_sms[]	delete(nitro_service client, sent_sms[] resources) Use this operation to delete sent sms details.
String	get_failed_message() Subject of the sms sent.
static sent_sms[]	get_filtered(nitro_service service, filtervalue[] filter) Use this API to fetch filtered set of sent_sms resources.
static sent_sms[]	get_filtered(nitro_service service, String filter) Use this API to fetch filtered set of sent_sms resources.
String	get_id() Id is system generated key for all the sent sms record.
Boolean	get_is_sent() Is this sms sent successfully.
Boolean	get_is_ssl() Is this sms sent as SSL.
String	get_message() Content of the sms sent.
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_profile_name() Profile name through which sms sent.
String	get_server_name() SMS server name
Double	get_timestamp() Time when the sms was sent
String	get_to_list() List of to whom send the sms.
String	get_url() URL used for sending the sms.
String	get_username() Username for the sms server
static sent_sms[]	get(nitro_service client) Use this operation to get sent sms details..
void	set_failed_message(String failed_message) Subject of the sms sent.
void	set_id(String id) Id is system generated key for all the sent sms record.
void	set_is_sent(Boolean is_sent) Is this sms sent successfully.
void	set_is_ssl(Boolean is_ssl) Is this sms sent as SSL.
void	set_message(String message) Content of the sms sent.
void	set_profile_name(String profile_name) Profile name through which sms sent.
void	set_server_name(String server_name) SMS server name
void	set_to_list(String to_list) List of to whom send the sms.
void	set_url(String url) URL used for sending the sms.
void	set_username(String username) Username for the sms server
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

sent_sms

public sent_sms()

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_to_list

public void set_to_list(String to_list)

 List of to whom send the sms. 
 

get_to_list

public String get_to_list()

 List of to whom send the sms. 
 

set_failed_message

public void set_failed_message(String failed_message)

 Subject of the sms sent.
 

get_failed_message

public String get_failed_message()

 Subject of the sms sent.
 

set_is_sent

public void set_is_sent(Boolean is_sent)

 Is this sms sent successfully.
 

get_is_sent

public Boolean get_is_sent()

 Is this sms sent successfully.
 

set_message

public void set_message(String message)

 Content of the sms sent.
 

get_message

public String get_message()

 Content of the sms sent.
 

set_username

public void set_username(String username)

 Username for the sms server
 

get_username

public String get_username()

 Username for the sms server
 

get_timestamp

public Double get_timestamp()

 Time when the sms was sent
 

set_url

public void set_url(String url)

 URL used for sending the sms. 
 

get_url

public String get_url()

 URL used for sending the sms. 
 

set_id

public void set_id(String id)

 Id is system generated key for all the sent sms record.
 

get_id

public String get_id()

 Id is system generated key for all the sent sms record.
 

set_is_ssl

public void set_is_ssl(Boolean is_ssl)

 Is this sms sent as SSL.
 

get_is_ssl

public Boolean get_is_ssl()

 Is this sms sent as SSL.
 

set_server_name

public void set_server_name(String server_name)

 SMS server name
 

get_server_name

public String get_server_name()

 SMS server name
 

set_profile_name

public void set_profile_name(String profile_name)

 Profile name through which sms sent.
 

get_profile_name

public String get_profile_name()

 Profile name through which sms sent.
 

delete

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

 Use this operation to delete sent sms details..
 

Throws:

Exception

delete

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

 Use this operation to delete sent sms details. in bulk.
 

Throws:

Exception

get

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

 Use this operation to get sent sms details..
 

Throws:

Exception

get_filtered

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

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

Throws:

Exception

get_filtered

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

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