com.quantum.dxi.rest.nas

Class ShareTargets

java.lang.Object

Base

com.quantum.dxi.rest.nas.ShareTargets

public class ShareTargets
extends Base

The ShareTargets resource represents the target host configuration for NAS shares on the system. The ShareTargets interface includes services for getting, updating, and deleting share targets.

The schema that defines the ShareTargets resource is defined below.

 
    <xs:element name="ShareTargets">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of share hosts</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="ReplicationTarget" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="ReplicationTarget">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="ObjectName" type="xs:string"/>
                <xs:element name="TargetName" type="xs:string"/>
                <xs:element name="Id" type="xs:string"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ReplicationTargetColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="TargetName"/>
            <xs:enumeration value="Id"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ShareTargets()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addShareTarget_1_1(javax.servlet.http.HttpServletRequest request, ReplicationTarget replicationTarget, String errorType) POST /rest/ShareTargets
ReplicationTarget	addShareTarget(javax.servlet.http.HttpServletRequest request, ReplicationTarget replicationTarget, String errorType) Deprecated. As of 1.1, @see #addShareTarget_1_1(HttpServletRequest, ReplicationTarget, String)
void	deleteShareTarget(javax.servlet.http.HttpServletRequest request, String id, String errorType) DELETE /rest/ShareTargets/{id}
com.quantum.dxi.dao.types.ShareTargets	getShareTargets(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString, String errorType) GET /rest/ShareTargets

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareTargets

public ShareTargets()

Method Detail

getShareTargets

public com.quantum.dxi.dao.types.ShareTargets getShareTargets(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              int start,
                                                              int limit,
                                                              String sortColumn,
                                                              String sortDirection,
                                                              String filterString,
                                                              String errorType)

GET /rest/ShareTargets

Get the NAS share target configuration on the system.

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

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

addShareTarget_1_1

public javax.ws.rs.core.Response addShareTarget_1_1(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    ReplicationTarget replicationTarget,
                                                    String errorType)

POST /rest/ShareTargets

Add a new replication target host for a share.

Request Entity type: <xs:element name="ReplicationTarget">
Response Entity type: <xs:element name="ReplicationTarget">

Since:

1.1

addShareTarget

public ReplicationTarget addShareTarget(@Context
                                        javax.servlet.http.HttpServletRequest request,
                                        ReplicationTarget replicationTarget,
                                        String errorType)

Deprecated. As of 1.1, @see #addShareTarget_1_1(HttpServletRequest, ReplicationTarget, String)

POST /rest/ShareTargets

Add a new replication target host for a share.

Request Entity type: <xs:element name="ReplicationTarget">
Response Entity type: <xs:element name="ReplicationTarget">

deleteShareTarget

public void deleteShareTarget(@Context
                              javax.servlet.http.HttpServletRequest request,
                              String id,
                              String errorType)

DELETE /rest/ShareTargets/{id}

Delete the share target identified by id