com.citrix.netscaler.nitro.resource.stat.pq.pqpolicy_stats Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nitro Show documentation
Show all versions of nitro Show documentation
The Citrix® NetScaler® NITRO client for Java allows you to configure and monitor the NetScaler appliance programmatically in Java based applications. Source code taken from Build 121 of NetScaler release 10.1
The newest version!
/*
* Copyright (c) 2008-2015 Citrix Systems, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.citrix.netscaler.nitro.resource.stat.pq;
import com.citrix.netscaler.nitro.resource.base.*;
import com.citrix.netscaler.nitro.service.nitro_service;
import com.citrix.netscaler.nitro.service.options;
import com.citrix.netscaler.nitro.util.*;
import com.citrix.netscaler.nitro.exception.nitro_exception;
class pqpolicy_response extends base_response
{
public pqpolicy_stats[] pqpolicy;
}
/**
* Statistics for PQ policy resource.
*/
public class pqpolicy_stats extends base_resource
{
private String policyname;
private String clearstats;
private Long pqtotavgqueuewaittime;
private Long pqavgqueuewaittimerate;
private Long pqavgclienttransactiontimems;
private Long pqavgclienttransactiontimemsrate;
private String pqvserverip;
private Integer pqvserverport;
private Long pqqdepth;
private Long pqqdepthrate;
private Long pqcurrentclientconnections;
private Long pqcurrentclientconnectionsrate;
private Long pqtotclientconnections;
private Long pqclientconnectionsrate;
private Long pqdropped;
private Long pqdroppedrate;
private Long totclienttransactions;
private Long clienttransactionsrate;
private Long pqtotqueuedepth;
private Long pqqueuedepthrate;
/**
*
* Name of the priority queuing policy whose statistics must be displayed. If a name is not provided, statistics of all priority queuing policies are shown.
*
*/
public void set_policyname(String policyname) throws Exception{
this.policyname = policyname;
}
/**
*
* Name of the priority queuing policy whose statistics must be displayed. If a name is not provided, statistics of all priority queuing policies are shown.
Minimum length = 1
*
*/
public String get_policyname() throws Exception {
return this.policyname;
}
/**
*
* Clear the statsistics / counters
*
*/
public void set_clearstats(String clearstats) throws Exception{
this.clearstats = clearstats;
}
/**
*
* Clear the statsistics / counters.
Possible values = basic, full
*
*/
public String get_clearstats() throws Exception {
return this.clearstats;
}
/**
*
* IP address of the virtual server to which this priority queuing policy is bound.
*
*/
public String get_pqvserverip() throws Exception {
return this.pqvserverip;
}
/**
*
* Rate (/s) counter for pqtotqueuedepth
*
*/
public Long get_pqqueuedepthrate() throws Exception {
return this.pqqueuedepthrate;
}
/**
*
* Rate (/s) counter for pqdropped
*
*/
public Long get_pqdroppedrate() throws Exception {
return this.pqdroppedrate;
}
/**
*
* Total number of waiting clients for this priority queuing policy.
*
*/
public Long get_pqtotqueuedepth() throws Exception {
return this.pqtotqueuedepth;
}
/**
*
* Port number of the virtual server to which this priority queuing policy is bound.
*
*/
public Integer get_pqvserverport() throws Exception {
return this.pqvserverport;
}
/**
*
* Total number of client transactions for this priority queuing policy.
*
*/
public Long get_totclienttransactions() throws Exception {
return this.totclienttransactions;
}
/**
*
* Rate (/s) counter for totclienttransactions
*
*/
public Long get_clienttransactionsrate() throws Exception {
return this.clienttransactionsrate;
}
/**
*
* Rate (/s) counter for pqcurrentclientconnections
*
*/
public Long get_pqcurrentclientconnectionsrate() throws Exception {
return this.pqcurrentclientconnectionsrate;
}
/**
*
* Rate (/s) counter for pqqdepth
*
*/
public Long get_pqqdepthrate() throws Exception {
return this.pqqdepthrate;
}
/**
*
* Number of clients waiting currently for this priority queuing policy.
*
*/
public Long get_pqqdepth() throws Exception {
return this.pqqdepth;
}
/**
*
* Rate (/s) counter for pqtotclientconnections
*
*/
public Long get_pqclientconnectionsrate() throws Exception {
return this.pqclientconnectionsrate;
}
/**
*
* Average time taken by a priority queuing client to complete its transaction for this priority queuing policy.
*
*/
public Long get_pqavgclienttransactiontimems() throws Exception {
return this.pqavgclienttransactiontimems;
}
/**
*
* Rate (/s) counter for pqavgclienttransactiontimems
*
*/
public Long get_pqavgclienttransactiontimemsrate() throws Exception {
return this.pqavgclienttransactiontimemsrate;
}
/**
*
* Average wait time for clients for this priority queuing policy.
*
*/
public Long get_pqtotavgqueuewaittime() throws Exception {
return this.pqtotavgqueuewaittime;
}
/**
*
* Total number of dropped transactions for this priority queuing policy.
*
*/
public Long get_pqdropped() throws Exception {
return this.pqdropped;
}
/**
*
* Total number of server connections established for serving clients for this priority queuing policy.
*
*/
public Long get_pqtotclientconnections() throws Exception {
return this.pqtotclientconnections;
}
/**
*
* Rate (/s) counter for pqtotavgqueuewaittime
*
*/
public Long get_pqavgqueuewaittimerate() throws Exception {
return this.pqavgqueuewaittimerate;
}
/**
*
* Current number of server connections established for serving clients for this priority queuing policy.
*
*/
public Long get_pqcurrentclientconnections() throws Exception {
return this.pqcurrentclientconnections;
}
/**
*
* converts nitro response into object and returns the object array in case of get request.
*
*/
protected base_resource[] get_nitro_response(nitro_service service, String response) throws Exception{
pqpolicy_response result = (pqpolicy_response) service.get_payload_formatter().string_to_resource(pqpolicy_response.class, response);
if(result.errorcode != 0) {
if (result.errorcode == 444) {
service.clear_session();
}
if(result.severity != null)
{
if (result.severity.equals("ERROR"))
throw new nitro_exception(result.message,result.errorcode);
}
else
{
throw new nitro_exception(result.message,result.errorcode);
}
}
return result.pqpolicy;
}
/**
*
* Returns the value of object identifier argument
*
*/
protected String get_object_name() {
return this.policyname;
}
/**
* Use this API to fetch the statistics of all pqpolicy_stats resources that are configured on netscaler.
*/
public static pqpolicy_stats[] get(nitro_service service) throws Exception{
pqpolicy_stats obj = new pqpolicy_stats();
pqpolicy_stats[] response = (pqpolicy_stats[])obj.stat_resources(service);
return response;
}
/**
* Use this API to fetch the statistics of all pqpolicy_stats resources that are configured on netscaler.
*/
public static pqpolicy_stats[] get(nitro_service service, options option) throws Exception{
pqpolicy_stats obj = new pqpolicy_stats();
pqpolicy_stats[] response = (pqpolicy_stats[])obj.stat_resources(service,option);
return response;
}
/**
* Use this API to fetch statistics of pqpolicy_stats resource of given name .
*/
public static pqpolicy_stats get(nitro_service service, String policyname) throws Exception{
pqpolicy_stats obj = new pqpolicy_stats();
obj.set_policyname(policyname);
pqpolicy_stats response = (pqpolicy_stats) obj.stat_resource(service);
return response;
}
public static class clearstatsEnum {
public static final String basic = "basic";
public static final String full = "full";
}
}