com.quantum.dxi.rest.replication

Class ReplicationSummaryInfo

java.lang.Object

Base

com.quantum.dxi.rest.replication.ReplicationSummaryInfo

public class ReplicationSummaryInfo
extends Base

The ReplicationSummaryInfo resource represents summary information for a NAS share with directory/file based replication enabled or a VTL partition with cartridge based replication enabled. The ReplicationSummaryInfo resource includes services for getting the information.

The schema that defines the Replication resource is defined below.

 
  <xs:element name="ReplicationSummary">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="NumberOfRequests" type="xs:string">
          <xs:annotation>
            <xs:documentation>The number of requests queued on the share or partition.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="LargeNumberOfTriggerRequests" type="xs:string">
          <xs:annotation>
            <xs:documentation>Unused, deprecated since 1.2.</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="NumberOfTriggerDetailsDisplayed" type="xs:string">
          <xs:annotation>
            <xs:documentation>Maximum number of queue entries that can be returned by the UnpackQueueItems resource</xs:documentation>
          </xs:annotation>
        </xs:element>
        <xs:element name="RateOfReplication" type="xs:string">
          <xs:annotation>
            <xs:documentation>Average transfer rate in MB/s.</xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
 
 

Constructor Summary

Constructors

Constructor and Description
ReplicationSummaryInfo()

Method Summary

Modifier and Type	Method and Description
ReplicationSummary	getReplicationSummaryInfo_1_1(javax.servlet.http.HttpServletRequest request, String objectName, String targetName, String objectType) Deprecated. As of 1.2, replaced by a pair of APIs: getReplicationSummaryInfo_share(HttpServletRequest, String, String) and getReplicationSummaryInfo_partition(HttpServletRequest, String, String)
ReplicationSummary	getReplicationSummaryInfo_partition(javax.servlet.http.HttpServletRequest request, String objectName, String targetName) GET /rest/ReplicationSummaryInfo/partition/{objectName}/{targetName}
ReplicationSummary	getReplicationSummaryInfo_share(javax.servlet.http.HttpServletRequest request, String objectName, String targetName) GET /rest/ReplicationSummaryInfo/share/{objectName}/{targetName}
ReplicationSummary	getReplicationSummaryInfo(javax.servlet.http.HttpServletRequest request, String objectName, String targetName, String objectType) Deprecated. As of 1.1, replaced by getReplicationSummaryInfo_1_1(HttpServletRequest, String, String, String)

Methods inherited from class java.lang.Object

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

Constructor Detail

ReplicationSummaryInfo

public ReplicationSummaryInfo()

Method Detail

getReplicationSummaryInfo_share

public ReplicationSummary getReplicationSummaryInfo_share(@Context
                                                          javax.servlet.http.HttpServletRequest request,
                                                          String objectName,
                                                          String targetName)

GET /rest/ReplicationSummaryInfo/share/{objectName}/{targetName}

Get the summary information for directory/file based replication of share {objectName} to target {targetName} (DNS name or ipAddress as it is configured on the system).

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

Since:

1.2

getReplicationSummaryInfo_partition

public ReplicationSummary getReplicationSummaryInfo_partition(@Context
                                                              javax.servlet.http.HttpServletRequest request,
                                                              String objectName,
                                                              String targetName)

GET /rest/ReplicationSummaryInfo/partition/{objectName}/{targetName}

Get the summary information for cartridge based replication of partition {objectName} to target {targetName} (DNS name or ipAddress as it is configured on the system).

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

Since:

1.2

getReplicationSummaryInfo_1_1

public ReplicationSummary getReplicationSummaryInfo_1_1(@Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        String objectName,
                                                        String targetName,
                                                        String objectType)

Deprecated. As of 1.2, replaced by a pair of APIs: getReplicationSummaryInfo_share(HttpServletRequest, String, String) and getReplicationSummaryInfo_partition(HttpServletRequest, String, String)

GET /rest/ReplicationSummaryInfo/{objectName}/{targetName}/{objectType}

Get the summary information for directory/file based replication of a share {objectName} or cartridge based replication of a partition {objectName} to target {targetName} (DNS name or ipAddress as it is configured on the system). {objectType} must be SHARE or PARTITION.

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

Since:

1.1

getReplicationSummaryInfo

public ReplicationSummary getReplicationSummaryInfo(@Context
                                                    javax.servlet.http.HttpServletRequest request,
                                                    String objectName,
                                                    String targetName,
                                                    String objectType)

Deprecated. As of 1.1, replaced by getReplicationSummaryInfo_1_1(HttpServletRequest, String, String, String)

GET /rest/ReplicationSummaryInfo

Get the summary information of a directory/file based replication share or a cartridge based replication partition to a specific target.

The objectName, targetName, and objectType query parameters are required, and will be used to identify a replication resource on the system.

• ?objectName={objectName} is the name of the share or partition
• ?targetName={targetName} is the name (DNS name or IP address as it is configured on the system) of the replication target.
• ?objectType=[SHARE|PARTITION] indicates the type of the replication resource, and must be SHARE or PARTITION

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