| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Typically, a client creates a history collector by using a filter on a potentially large set, such as all the events in a datacenter. The collector provides access to the items that match the filter, which could also be a relatively large set.
The items in a collector are always ordered by date and time of creation. Item properties normally include this time stamp.
The client may set the "viewable latest page" for the collector, which is the contiguous subset of the items that are of immediate interest. These items are available as the "latestPage" property, which the client may retrieve and monitor by using the PropertyCollector managed object.
Clients can change the page size of the "latestPage" by using SetCollectorPageSize.
The client may use the following features of the history collector.
Properties
Name | Type | Description |
---|---|---|
filter | xsd:anyType |
The filter used to create this collector.
The type of the returned filter is determined by the managed object
for which the collector is created.
|
Methods
Methods defined in this Managed Object |
---|
DestroyCollector, ResetCollector, RewindCollector, SetCollectorPageSize |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HistoryCollector used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HistoryCollector used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HistoryCollector used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the HistoryCollector used to make the method call. |
maxCount P | xsd:int |
The maximum number of items in the page.
Since 2.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |