GetDocumentAggregatesRequest Class

Relativity Processing Services
Represents a request object containing criteria for retrieving aggregate information from processing sets in a specified workspace.
Inheritance Hierarchy

SystemObject
  Relativity.Processing.ServicesGetDocumentAggregatesRequest

Namespace:  Relativity.Processing.Services
Assembly:  Relativity.Processing.Services.Interfaces (in Relativity.Processing.Services.Interfaces.dll) Version: b44b4b567bbab080f9f68472e841682bf13da2db
Syntax

public class GetDocumentAggregatesRequest

The GetDocumentAggregatesRequest type exposes the following members.

Constructors

  NameDescription
Public methodGetDocumentAggregatesRequest
The default constructor for creating the request object.
Top
Properties

  NameDescription
Public propertyPage
Specifies the number used to identify a specific page of processing sets to return in the results set. This property is optional and set to the first page (0) by default.
Public propertyPageSize
The number of processing sets returned per page in the results set.
Public propertySortColumnName
The name of column used for sorting results. This property is optional and uses the column "ProcessingSetName" by default.
Public propertySortDescending
Indicates the sort order for the results. This property is optional and set to ascending by default.
Public propertyWorkspaceArtifactId
The Artifact ID of the workspace containing processing sets for retrieval.
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
See Also

Reference