Scripting Object - VcHistoryCollector

Scripting-object corresponding to
HistoryCollector

Scripting Object Description

This managed object type enables clients to retrieve historical data and receive updates when the server appends new data to a collection. This is a base type for item-specific types related to event or task history. Historical data is inherently append-only, although a server administrator may periodically purge old data.

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 {@link vmodl.query.PropertyCollector PropertyCollector} managed object.

Clients can change the page size of the "latestPage" by using {@link vim.HistoryCollector#setLatestPageSize setLatestPageSize()}.

The client may use the following features of the history collector.

Attributes

Name Type Description
filter_AnyValueObject

@since VI API 2.5
filter_FloatValueNumber

@since VI API 2.5
filter_IntValueNumber

@since VI API 2.5
filter_LongValueNumber

@since VI API 2.5
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, destroyCollector, resetCollector, rewindCollector, setCollectorPageSize

setCollectorPageSize

Sets the "viewable latest page" size to contain at most the number of items specified by the maxCount parameter).

@since VI API 2.5

Parameters

NameTypeDescription
arg0Number


Return Value

Type Description
None

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

rewindCollector

Moves the "scrollable view" to the oldest item. If you use {@link vim.TaskHistoryCollector#readNext ReadNextTasks} or {@link vim.event.EventHistoryCollector#readNext ReadNextEvents}, all items are retrieved from the oldest item to the newest item. This is the default setting when the collector is created. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

destroyCollector

Destroys this collector. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

resetCollector

Moves the "scrollable view" to the item immediately preceding the "viewable latest page". If you use "readPrev", {@link vim.TaskHistoryCollector#readPrev ReadPreviousTasks} or {@link vim.event.EventHistoryCollector#readPrev ReadPreviousEvents}, all items are retrieved from the newest item to the oldest item. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None