com.quantum.dxi.rest.network

Class Throttles

java.lang.Object

Base

com.quantum.dxi.rest.network.Throttles

public class Throttles
extends Base

The Throttles resource represents network throttling on the source system. The Throttles interface includes services for getting details about throttle configuration, creating, updating and deleting throttles.

The schema that defines the Throttles resource is defined below.

 
    <xs:element name="ThrottleInfo">
        <xs:annotation>
            <xs:documentation>Contains throttling info for a network service.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="InterfaceName" type="xs:string"/>
                <xs:element name="Service" minOccurs="0">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="REP"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="Bandwidth" type="xs:long" minOccurs="0"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="Throttles">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of throttles</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="ThrottleInfo" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ThrottleColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="InterfaceName"/>
            <xs:enumeration value="Service"/>
            <xs:enumeration value="Bandwidth"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Throttles()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addThrottle_1_1(javax.servlet.http.HttpServletRequest request, ThrottleInfo throttleInfo) POST /rest/Throttles
ThrottleInfo	addThrottle(javax.servlet.http.HttpServletRequest request, ThrottleInfo throttleInfo) Deprecated. As of 1.1, replaced by {#addThrottle_1_1(HttpServletRequest, ThrottleInfo)}
void	deleteThrottle(javax.servlet.http.HttpServletRequest request, String interfaceName) DELETE /rest/Throttles/{interfaceName}
Object	getThrottles(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String actionString, String filterString, String errorType) GET /rest/Throttles
NumericScalarType	getThrottlesCount(javax.servlet.http.HttpServletRequest request, int start, int limit, String filterString, String errorType) GET /rest/Throttles/getRowCount
ThrottleInfo	updateThrottle(javax.servlet.http.HttpServletRequest request, String interfaceName, ThrottleInfo throttleInfo) PUT /rest/Throttles/{interfaceName}

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Throttles

public Throttles()

Method Detail

getThrottlesCount

public NumericScalarType getThrottlesCount(@Context
                                           javax.servlet.http.HttpServletRequest request,
                                           int start,
                                           int limit,
                                           String filterString,
                                           String errorType)

GET /rest/Throttles/getRowCount

Get the number of interfaces for which throttling is active. NOTE! At the moment the only supported interface is "system", which stands for all network interfaces. That means the number can be either 1 (when throttling is enabled) or 0 (when it is disabled).

getThrottlesCount supports the table query parameters for filtering by column name. Column names are defined in <xs:element name="ThrottleColumnName">

Response Entity type: <xs:element name="NumericScalarType">

Since:

1.1

getThrottles

public Object getThrottles(@Context
                           javax.servlet.http.HttpServletRequest request,
                           int start,
                           int limit,
                           String sortColumn,
                           String sortDirection,
                           @Deprecated
                           String actionString,
                           String filterString,
                           String errorType)

GET /rest/Throttles

Get the network throttles on the system.

Response Entity type: <xs:element name="Throttles">

<xs:element name="Throttles"> supports the table query parameters. Column names for sorting and filtering are defined in <xs:element name="ThrottleColumnName">

Deprecated as of 1.1:
The "action" query parameter is deprecated.
?action=getRowCount replaced by getThrottlesCount(HttpServletRequest, int, int, String, String)

Response Entity type: <xs:element name="NumericScalarType"> for query parameter ?action=getRowCount

addThrottle_1_1

public javax.ws.rs.core.Response addThrottle_1_1(@Context
                                                 javax.servlet.http.HttpServletRequest request,
                                                 ThrottleInfo throttleInfo)

POST /rest/Throttles

Create a new network throttle for a given service on the specified interface. NOTE! At the moment the only supported service is "REP" (replication), and the only supported interface is "system", which stands for all network interfaces.

Request Entity type: <xs:element name="ThrottleInfo">

Response Entity type: <xs:element name="ThrottleInfo">

Since:

1.1

addThrottle

public ThrottleInfo addThrottle(@Context
                                javax.servlet.http.HttpServletRequest request,
                                ThrottleInfo throttleInfo)

Deprecated. As of 1.1, replaced by {#addThrottle_1_1(HttpServletRequest, ThrottleInfo)}

POST /rest/Throttles

Create a new network throttle for a given service on the specified interface. NOTE! At the moment the only supported service is "REP" (replication), and the only supported interface is "system", which stands for all network interfaces.

Request Entity type: <xs:element name="ThrottleInfo">

Response Entity type: <xs:element name="ThrottleInfo">

updateThrottle

public ThrottleInfo updateThrottle(@Context
                                   javax.servlet.http.HttpServletRequest request,
                                   String interfaceName,
                                   ThrottleInfo throttleInfo)

PUT /rest/Throttles/{interfaceName}

Update the throttle configuration on the network interface identified by {interfaceName}.

NOTE! At the moment the only supported service is "REP" (replication), and the only supported interface is "system", which stands for all network interfaces.

Request Entity type: <xs:element name="ThrottleInfo">

Response Entity type: <xs:element name="ThrottleInfo">

deleteThrottle

public void deleteThrottle(@Context
                           javax.servlet.http.HttpServletRequest request,
                           String interfaceName)

DELETE /rest/Throttles/{interfaceName}

Delete the throttle configuration on the network interface identified by {interfaceName}.

NOTE! At the moment the only supported interface is "system", which stands for all network interfaces.