com.quantum.dxi.rest.dxi

Class Events

java.lang.Object

Base

com.quantum.dxi.rest.dxi.Events

Deprecated.

Use ResourceEventsWebService instead.

public class Events
extends Base

The Event resource represents scheduled events on the system. Events can be scheduled as one-time events or as recurring events. There are several different types of events, as described in the schema.

The schema that defines the Events resource is defined below.

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

  <xs:element name="Event" type="EventType">
    <xs:annotation>
      <xs:documentation>single event</xs:documentation>
    </xs:annotation>
  </xs:element>
  <xs:complexType name="EventType">
    <xs:sequence>
      <xs:element name="Id" type="xs:string">
        <xs:annotation>
          <xs:documentation>Unique identifier for event
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Type" type="common:NameType">
        <xs:annotation>
          <xs:documentation>HealthCheck, SpaceReclamation,
            ShareReplication, PartitionReplication,
            ReplicationThrottling, ScriptExecution, EmailReports
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Title" type="xs:string" minOccurs="0">
        <xs:annotation>
          <xs:documentation>Object Name or a Display Name for the Event
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Start" type="xs:long">
        <xs:annotation>
          <xs:documentation>milliseconds since epoc</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="End" type="xs:long" minOccurs="0">
        <xs:annotation>
          <xs:documentation>milliseconds since epoch</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Recurrence" type="xs:string"
        minOccurs="0">
        <xs:annotation>
          <xs:documentation>Recurrence in iCal format</xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="HasModifiedInstance" type="xs:boolean">
        <xs:annotation>
          <xs:documentation>Indicates at least one instance has been
            modified.
          </xs:documentation>
        </xs:annotation>
      </xs:element>
      <xs:element name="Target" type="xs:string" minOccurs="0" maxOccurs="unbounded" />
    </xs:sequence>
  </xs:complexType>

  <xs:element name="ThrottleEvent" type="ThrottleEventType" />
  <xs:complexType name="ThrottleEventType">
    <xs:annotation>
      <xs:documentation>Throttle Event</xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="EventType">
        <xs:sequence>
          <xs:element name="Bandwidth" type="xs:long" />
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:element name="ShareReplicationEvent" type="ShareReplicationEventType" />
  <xs:complexType name="ShareReplicationEventType">
    <xs:annotation>
      <xs:documentation>Share Replication</xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="EventType">
        <xs:sequence>
          <xs:element name="ShareName" type="xs:string">
            <xs:annotation>
              <xs:documentation>Share Name</xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:element name="PartitionReplicationEvent" type="PartitionReplicationEventType" />
  <xs:complexType name="PartitionReplicationEventType">
    <xs:annotation>
      <xs:documentation>Partition Replication</xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="EventType">
        <xs:sequence>
          <xs:element name="PartitionName" type="xs:string">
            <xs:annotation>
              <xs:documentation>Partition Name</xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:element name="EmailReportsEvent" type="EmailReportsEventType" />
  <xs:complexType name="EmailReportsEventType">
    <xs:annotation>
      <xs:documentation>EmailReports Event</xs:documentation>
    </xs:annotation>
    <xs:complexContent>
      <xs:extension base="EventType">
        <xs:sequence>
          <xs:element name="EmailType" type="common:EmailType">
            <xs:annotation>
              <xs:documentation>Status or Config</xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:element name="ScriptExecutionEvent" type="ScriptExecutionEventType" />
  <xs:complexType name="ScriptExecutionEventType">
    <xs:complexContent>
      <xs:extension base="EventType">
        <xs:sequence>
          <xs:element name="ScriptName" type="xs:string" />
          <xs:element name="ScriptParameters" type="xs:string"
            minOccurs="0">
            <xs:annotation>
              <xs:documentation>param1 param2 param3 ...
              </xs:documentation>
            </xs:annotation>
          </xs:element>
        </xs:sequence>
      </xs:extension>
    </xs:complexContent>
  </xs:complexType>

  <xs:simpleType name="EventColumnNameType">
    <xs:restriction base="xs:string">
      <xs:enumeration value="Type" />
      <xs:enumeration value="Start" />
      <xs:enumeration value="End" />
      <xs:enumeration value="ShareName" />
      <xs:enumeration value="PartitionName" />
      <xs:enumeration value="Target" />
    </xs:restriction>
  </xs:simpleType>
 
 

Constructor Summary

Constructors

Constructor and Description
Events() Deprecated.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addEvent_1_1(javax.servlet.http.HttpServletRequest request, java.io.InputStream is) Deprecated. POST /rest/Events
com.quantum.dxi.jaxb.event.EventType	addEvent(javax.servlet.http.HttpServletRequest request, java.io.InputStream is) Deprecated. POST /rest/Events
void	deleteEvent(javax.servlet.http.HttpServletRequest request, java.lang.String id) Deprecated. DELETE /rest/Events/{id}
com.quantum.dxi.jaxb.event.EventType	getEvent(javax.servlet.http.HttpServletRequest request, java.lang.String id) Deprecated. GET /rest/Events/{id}
com.quantum.dxi.jaxb.event.Events	getEvents(javax.servlet.http.HttpServletRequest request, int start, int limit, java.lang.String filterString) Deprecated. GET /rest/Events
com.quantum.dxi.jaxb.event.EventType	updateEvent(javax.servlet.http.HttpServletRequest request, java.lang.String id, java.io.InputStream is) Deprecated. PUT /rest/Events/{id}

Methods inherited from class java.lang.Object

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

Constructor Detail

Events

public Events()

Deprecated.

Method Detail

getEvents

public com.quantum.dxi.jaxb.event.Events getEvents(@Context
                                                   javax.servlet.http.HttpServletRequest request,
                                                   int start,
                                                   int limit,
                                                   java.lang.String filterString)

Deprecated.

GET /rest/Events

Get the list of scheduled Events on the system.

<xs:element name="getEvents"> supports the table query parameters for paging, and filtering by column name. Column names are defined in <xs:simpleType name="EventColumnNameType">

EventStart is a time in milliseconds since the Unix epoch of 1970. It represents the beginning of the time range you wish to get events for. EventEnd is a time in milliseconds since the Unix epoch of 1970. It represents the end of the time range you wish to get events for.

If only EventStart is specified, all events from EventStart plus 30 days are returned. If only EventEnd is specified, all events from midnight this morning until EventEnd are returned. If EventStart and EventEnd are both specified all events from EventStart to EventEnd are returned. If neither EventStart or EventEnd are specified, all events from midnight this morning plus 30 days are returned. The maximum number of events ever returned will be limited to 7 * 1024 in order to not run the system out of memory.

EventType specifies the type of event you are interested in. If you want all the events reguardless of type, simply leave it out of the filter.

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

See Also:

EventTypes

getEvent

public com.quantum.dxi.jaxb.event.EventType getEvent(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     java.lang.String id)

Deprecated.

GET /rest/Events/{id}

Get an Event, identified by {id}. An event is identified by its id field, <xs:element name="Id" type="xs:string">. If an event is a recurring event, as identifed by the value of its <xs:element name="Recurrence" type="xs:string">, you can get either the recurring series, or a single instance of the Event. A single instance of a recurring event is identified by appending an at-sign (@) followed by a timetamp to the id. For example,

• GET /rest/Events/12 gets the entire series of a recurring event, identified by id 12
• GET /rest/Events/12@1323072000000 gets the instance at time 1323072000000 of the recurring series

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

deleteEvent

public void deleteEvent(@Context
                        javax.servlet.http.HttpServletRequest request,
                        java.lang.String id)

Deprecated.

DELETE /rest/Events/{id}

Delete an Event, identified by {id}. An event is identified by its id field, <xs:element name="Id" type="xs:string">. If an event is a recurring event, as identifed by the value of its <xs:element name="Recurrence" type="xs:string">, you can delete either the recurring series, or a single Instance of the Event. A single instance of a recurring event is identified by appending an at-sign (@) followed by a timetamp to the id. For example,

• DELETE /rest/Events/12 deletes the entire series of a recurring event, identified by id 12
• DELETE /rest/Events/12@1323072000000 deletes the instance at time 1323072000000 of the recurring series

updateEvent

public com.quantum.dxi.jaxb.event.EventType updateEvent(@Context
                                                        javax.servlet.http.HttpServletRequest request,
                                                        java.lang.String id,
                                                        java.io.InputStream is)

Deprecated.

PUT /rest/Events/{id}

Update an Event, identified by {id}. An event is identified by its id field, <xs:element name="Id" type="xs:string">. If an event is a recurring event, as identifed by the value of its <xs:element name="Recurrence" type="xs:string">, you can modify either the recurring series, or a single instance of the Event. A single instance of a recurring event is identified by appending an at-sign (@) followed by a timetamp to the id. For example,

• PUT /rest/Events/12 modifies the entire series of a recurring event, identified by id 12
• PUT /rest/Events/12@1323072000000 modifies the instance at time 1323072000000 of the recurring series

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

addEvent_1_1

public javax.ws.rs.core.Response addEvent_1_1(@Context
                                              javax.servlet.http.HttpServletRequest request,
                                              java.io.InputStream is)

Deprecated.

POST /rest/Events

Add a new Event to the system.

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

addEvent

public com.quantum.dxi.jaxb.event.EventType addEvent(@Context
                                                     javax.servlet.http.HttpServletRequest request,
                                                     java.io.InputStream is)

Deprecated.

POST /rest/Events

Add a new Event to the system.

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