com.quantum.dxi.rest.replication

Class ShareReplicationConfiguration

java.lang.Object

Base

com.quantum.dxi.rest.replication.ShareReplicationConfiguration

public class ShareReplicationConfiguration
extends Base

The ShareReplicationConfiguration resource represents the incoming replication configuration of shares on the system. The resource includes services for getting and updating the replication configuration for shares.

The schema that defines the ShareReplicationConfiguration resource is defined below.

 
    <xs:simpleType name="SharitionType">
        <xs:annotation>
            <xs:documentation>Share or Partition</xs:documentation>
        </xs:annotation>
        <xs:restriction base="xs:string">
            <xs:enumeration value="SHARE"/>
            <xs:enumeration value="PARTITION"/>
        </xs:restriction>
    </xs:simpleType>

    <xs:element name="ReplicationConfigurations">
        <xs:complexType>
            <xs:sequence>
                <xs:element name="TotalCount" type="xs:int" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Total number of replication configurations</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element ref="ReplicationConfiguration" minOccurs="0" maxOccurs="unbounded"/>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:element name="ReplicationConfiguration">
        <xs:annotation>
            <xs:documentation>Defines replication receive configuration on the target system. In future may be extended to also support send replication.</xs:documentation>
        </xs:annotation>
        <xs:complexType>
            <xs:sequence>
                <xs:element name="ObjectName" type="xs:string"/>
                <xs:element name="ObjectType" type="SharitionType"/>
                <xs:element name="TbType">
                    <xs:simpleType>
                        <xs:restriction base="xs:string">
                            <xs:enumeration value="NONE"/>
                            <xs:enumeration value="SOURCE"/>
                            <xs:enumeration value="DESTINATION"/>
                        </xs:restriction>
                    </xs:simpleType>
                </xs:element>
                <xs:element name="TbSyncId" type="xs:string" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Only if TbType != NONE</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="TbTargetLocked" type="xs:boolean" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>Only if TbType == DESTINATION</xs:documentation>
                    </xs:annotation>
                </xs:element>
                <xs:element name="LastSyncTime" type="xs:long" minOccurs="0">
                    <xs:annotation>
                        <xs:documentation>
                            Since 1.2.3. Seconds since epoch (read-only).
                            Last time directory/file or cartridge based
                            replication occurred.
                        </xs:documentation>
                    </xs:annotation>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>

    <xs:simpleType name="ReplicationConfigurationColumnNameType">
        <xs:restriction base="xs:string">
            <xs:enumeration value="ObjectName"/>
            <xs:enumeration value="ObjectType"/>
            <xs:enumeration value="TbType"/>
            <xs:enumeration value="TbSyncId"/>
            <xs:enumeration value="TbTargetLocked"/>
            <xs:enumeration value="LastSyncTime"/>
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
ShareReplicationConfiguration()

Method Summary

Modifier and Type	Method and Description
ReplicationConfiguration	getReplicationConfiguration(javax.servlet.http.HttpServletRequest request, java.lang.String objectName) GET /rest/ShareReplicationConfiguration/{objectName}
com.quantum.dxi.dao.types.ReplicationConfigurations	getReplicationConfigurations(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String sortColumn, java.lang.String sortDirection, java.lang.String filterString) GET /rest/ShareReplicationConfiguration
ReplicationConfiguration	updateReplicationConfiguration(javax.servlet.http.HttpServletRequest request, java.lang.String objectName, ReplicationConfiguration replicationConfiguration) PUT /rest/ShareReplicationConfiguration/{objectName}

Methods inherited from class java.lang.Object

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

Constructor Detail

ShareReplicationConfiguration

public ShareReplicationConfiguration()

Method Detail

getReplicationConfigurations

public com.quantum.dxi.dao.types.ReplicationConfigurations getReplicationConfigurations(@Context
                                                                                        javax.servlet.http.HttpServletRequest request,
                                                                                        int start,
                                                                                        int limit,
                                                                                        java.lang.String sortColumn,
                                                                                        java.lang.String sortDirection,
                                                                                        java.lang.String filterString)

GET /rest/ShareReplicationConfiguration

Get incoming replication configuration of NAS shares on the system.

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

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

getReplicationConfiguration

public ReplicationConfiguration getReplicationConfiguration(@Context
                                                            javax.servlet.http.HttpServletRequest request,
                                                            java.lang.String objectName)

GET /rest/ShareReplicationConfiguration/{objectName}

Get the incoming replication configuration for the NAS share identified by {objectName}. The {objectName} will match against the <xs:element name="ObjectName" type="xs:string"> of the schema to find the share of interest.

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

updateReplicationConfiguration

public ReplicationConfiguration updateReplicationConfiguration(@Context
                                                               javax.servlet.http.HttpServletRequest request,
                                                               java.lang.String objectName,
                                                               ReplicationConfiguration replicationConfiguration)

PUT /rest/ShareReplicationConfiguration/{objectName}

Update the incoming replication configuration for the NAS share identified by {objectName} on the system. The {objectName} will match against the <xs:element name="ObjectName" type="xs:string"> of the schema to find the share of interest.

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

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