Click or drag to resize
OSIsoft, LLC

PIPagingConfiguration Class

The PIPagingConfiguration is used to describe how PIPointList and AFListData data access calls should page results for better performance.
Inheritance Hierarchy
SystemObject
  OSIsoft.AF.PIPIPagingConfiguration

Namespace:  OSIsoft.AF.PI
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 2.10.6.195
Syntax
public class PIPagingConfiguration

The PIPagingConfiguration type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyBulkPayloadPercentThreshold
This value represents a percentage of the entire RPC that must be completed to cause a page to be proactively returned to prevent the operation timeout from expiring.
Public propertyError
Contains the exception that caused the OperationCanceledException to be thrown canceling the operation.
Public propertyKeepAliveTimeout
This value is the maximum amount of time allowed to elapse between calls to get the next page of results.
Public propertyMaximumRetries
The maximum number of times to retry when encountering an error from PIServer for exceeding the maximum number of concurrent bulk queries. It must be a non-negative number. The default value is 5.
Public propertyOperationTimeoutOverride
This value overrides the operation timeout set on the PIServer for the duration of the data access call. The operation timeout is the maximum amount of time that can elapse on the PIServer while fetching each page.
Public propertyPageSize
The size of the pages that will be returned depending on the PageType.
Public propertyPageType
The PageType is used to determine how partial results from list data access calls should be grouped while being returned to the client. Choosing the appropriate page type will improve performance.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

AFSDK

Supported in: 2.10.5, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6
See Also

Reference

Enabling Operational Intelligence