com.quantum.dxi.rest.cloudshare

Class CloudShareConfigs

java.lang.Object

Base

com.quantum.dxi.rest.cloudshare.CloudShareConfigs

public class CloudShareConfigs
extends Base

The CloudShareConfigs resource represents Cloud Share settings of shares and LSUs. The CloudShareConfigs service includes interfaces for getting and updating the settings.

The schema that defines the CloudConfigs is defined below.

 
    <xs:element name="CloudConfigs">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="TotalCount" type="xs:int" minOccurs="0" />
          <xs:element ref="CloudConfig" minOccurs="0" maxOccurs="unbounded" />
        </xs:sequence>
      </xs:complexType>
    </xs:element>

    <xs:element name="CloudConfig">
      <xs:complexType>
        <xs:sequence>
          <xs:element name="StorageServer" type="xs:string" minOccurs="0"/>
          <xs:element name="ObjectName" type="xs:string" minOccurs="0"/>
          <xs:element name="Provider" type="xs:string" minOccurs="0">
            <xs:annotation>
              <xs:documentation>Read-only convenience field indicating cloud provider name.</xs:documentation>
            </xs:annotation>
          </xs:element>
          <xs:choice>
            <xs:element name="S3" type="S3"/>
          </xs:choice>
          <xs:element name="Lifetime" minOccurs="0">
            <xs:simpleType>
              <xs:restriction base="xs:int">
                <xs:minInclusive value="0"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:element>
          <xs:element name="Error" type="xs:string" minOccurs="0"/>
          <xs:element name="AutoRestore" type="xs:boolean" minOccurs="0"/>
          <xs:element name="Secondary" type="xs:boolean" minOccurs="0"/>
          <xs:element name="Ownership" type="xs:string" minOccurs="0"/>
          <xs:element name="DxiSerial" type="xs:string" minOccurs="0"/>
          <xs:element name="CurrentBucketOwner" type="xs:string" minOccurs="0" />
        </xs:sequence>
      </xs:complexType>
    </xs:element>

    <xs:complexType name="S3">
      <xs:all>
        <xs:element name="Bucket" type="xs:string" minOccurs="0"/>
        <xs:element name="Endpoint" type="xs:string" minOccurs="0"/>
        <xs:element name="KeyId" type="xs:string" minOccurs="0"/>
        <xs:element name="SecretKey" type="xs:string" minOccurs="0">
          <xs:annotation>
            <xs:documentation>
              Secret key is write only and not returned with GET.
              It is required when initially setting CloudConfig.
            </xs:documentation>
          </xs:annotation>
        </xs:element>
      </xs:all>
    </xs:complexType>

    <xs:simpleType name="CloudConfigColumnNameType">
        <xs:restriction base="xs:string">
          <xs:enumeration value="StorageServer" />
          <xs:enumeration value="ObjectName" />
          <xs:enumeration value="Lifetime" />
          <xs:enumeration value="Provider" />
          <xs:enumeration value="Error" />
        </xs:restriction>
    </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
CloudShareConfigs()

Method Summary

Modifier and Type	Method and Description
CloudConfigs	getAllLsuConfigs(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /rest/CloudShareConfigs/lsu
CloudConfigs	getAllShareConfigs(javax.servlet.http.HttpServletRequest request, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /rest/CloudShareConfigs/share
CloudConfig	getLsuConfig(javax.servlet.http.HttpServletRequest request, String storageServer, String name) GET /rest/CloudShareConfigs/lsu/{storageServer}/{name}
CloudConfig	getShareConfig(javax.servlet.http.HttpServletRequest request, String name) GET /rest/CloudShareConfigs/share/{name}
CloudConfigs	getSsLsuConfigs(javax.servlet.http.HttpServletRequest request, String storageServer, int start, int limit, String sortColumn, String sortDirection, String filterString) GET /rest/CloudShareConfigs/lsu/{storageServer}
CloudConfig	setLsuConfig(javax.servlet.http.HttpServletRequest request, String storageServer, String name, CloudConfig config) PUT /rest/CloudShareConfigs/lsu/{storageServer}/{name}
CloudConfig	setShareConfig(javax.servlet.http.HttpServletRequest request, String name, CloudConfig config) PUT /rest/CloudShareConfigs/share/{name}
void	syncLsu(javax.servlet.http.HttpServletRequest request, String storageServer, String name) POST /rest/CloudShareConfigs/sync/lsu/{storageServer}/{name}
void	syncShare(javax.servlet.http.HttpServletRequest request, String name) POST /rest/CloudShareConfigs/sync/share/{name}

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudShareConfigs

public CloudShareConfigs()

Method Detail

getAllShareConfigs

public CloudConfigs getAllShareConfigs(@Context
                                       javax.servlet.http.HttpServletRequest request,
                                       int start,
                                       int limit,
                                       String sortColumn,
                                       String sortDirection,
                                       String filterString)

GET /rest/CloudShareConfigs/share

Get Cloud Share settings for all shares on the system.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

getAllLsuConfigs

public CloudConfigs getAllLsuConfigs(@Context
                                     javax.servlet.http.HttpServletRequest request,
                                     int start,
                                     int limit,
                                     String sortColumn,
                                     String sortDirection,
                                     String filterString)

GET /rest/CloudShareConfigs/lsu

Get Cloud Share settings for all LSUs on the system.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

getSsLsuConfigs

public CloudConfigs getSsLsuConfigs(@Context
                                    javax.servlet.http.HttpServletRequest request,
                                    String storageServer,
                                    int start,
                                    int limit,
                                    String sortColumn,
                                    String sortDirection,
                                    String filterString)

GET /rest/CloudShareConfigs/lsu/{storageServer}

Get Cloud Share settings for LSUs that belong to the specified storage server.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

getShareConfig

public CloudConfig getShareConfig(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  String name)

GET /rest/CloudShareConfigs/share/{name}

Get Cloud Share settings for the specified share.

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

Since:

1.2.6 Please be sure it is supported by the installed software.

getLsuConfig

public CloudConfig getLsuConfig(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String storageServer,
                                String name)

GET /rest/CloudShareConfigs/lsu/{storageServer}/{name}

Get Cloud Share settings for the specified LSU.

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

Since:

1.2.6 Please be sure it is supported by the installed software.

setShareConfig

public CloudConfig setShareConfig(@Context
                                  javax.servlet.http.HttpServletRequest request,
                                  String name,
                                  CloudConfig config)

PUT /rest/CloudShareConfigs/share/{name}

Set/update Cloud Share settings for the specified share.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

setLsuConfig

public CloudConfig setLsuConfig(@Context
                                javax.servlet.http.HttpServletRequest request,
                                String storageServer,
                                String name,
                                CloudConfig config)

PUT /rest/CloudShareConfigs/lsu/{storageServer}/{name}

Set/update Cloud Share settings for the specified LSU.

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

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

Since:

1.2.6 Please be sure it is supported by the installed software.

syncShare

public void syncShare(@Context
                      javax.servlet.http.HttpServletRequest request,
                      String name)

POST /rest/CloudShareConfigs/sync/share/{name}

Synchronize the specified Share from the cloud in read-only mode.

Since:

1.2.9 Please be sure it is supported by the installed software.

syncLsu

public void syncLsu(@Context
                    javax.servlet.http.HttpServletRequest request,
                    String storageServer,
                    String name)

POST /rest/CloudShareConfigs/sync/lsu/{storageServer}/{name}

Synchronize the specified LSU from the cloud in read-only mode.

Since:

1.2.9 Please be sure it is supported by the installed software.