Represents a request object containing criteria for retrieving aggregate information from processing sets in a specified workspace.
Inheritance Hierarchy
Relativity.Processing.ServicesGetDocumentAggregatesRequest
Namespace: Relativity.Processing.Services
Assembly: Relativity.Processing.Services.Interfaces (in Relativity.Processing.Services.Interfaces.dll) Version: b44b4b567bbab080f9f68472e841682bf13da2db
Syntax
The GetDocumentAggregatesRequest type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | GetDocumentAggregatesRequest |
The default constructor for creating the request object.
|
Properties
Name | Description | |
---|---|---|
![]() | Page |
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.
|
![]() | PageSize |
The number of processing sets returned per page in the results set.
|
![]() | SortColumnName |
The name of column used for sorting results. This property is optional and uses the column "ProcessingSetName" by default.
|
![]() | SortDescending |
Indicates the sort order for the results. This property is optional and set to ascending by default.
|
![]() | WorkspaceArtifactId |
The Artifact ID of the workspace containing processing sets for retrieval.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also