The string names of fields used on Batch Sets.
Inheritance Hierarchy
kCura.Relativity.Client.DTOs.ArtifactFieldNames
kCura.Relativity.Client.DTOs.BatchSetFieldNames
Namespace: kCura.Relativity.Client.DTOs
Assembly: kCura.Relativity.Client (in kCura.Relativity.Client.dll) Version: 640db774aa42dfbe1785add27fbb41844ec5c7d4
Syntax
The BatchSetFieldNames type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | BatchSetFieldNames | Initializes a new instance of the BatchSetFieldNames class |
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.) |
Fields
| Name | Description | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  | AutoBatch |
Indicates whether the batch set automatically generates batches.
| ||||||||||
| AutoCreateRateMinutes |
Represents how frequently (in minutes) the system will attempt to create batches.
| ||||||||||
| BatchDataSource |
Represents a saved search containing documents to batch.
| ||||||||||
| BatchPrefix |
Represents a batch prefix for this batch set.
The name of a batch contains this prefix followed by the batch numbering.
| ||||||||||
| BatchUnitField |
Represents an optional field used for grouping similar documents in the same batch.
| ||||||||||
| DocumentsToBeBatched |
Represents the remaining documents submitted for batching, which do not meet the minimum batch size.
| ||||||||||
| FamilyField |
Represents the workspace group identifier.
| ||||||||||
| LastErrorReported |
Indicates the last error reported for a batch set. This field is read-only.
| ||||||||||
| LastSuccessfulRun |
Indicates the last successful run for a batch set. This field is read-only.
| ||||||||||
| MaximumBatchSize |
Determines the maximum number of documents in a single batch.
| ||||||||||
| MinimumBatchSize |
Determines the smallest number of documents in a single batch.
| ||||||||||
| Name |
Represents the name of a batch set as a string.
| ||||||||||
| PreConvertDocuments |
Indicates the Yes/No, field that keeps track of whether a batch set should have its documents converted upon Batching.
Note if Batching occurs via RSAPI, this field is not respected.
| ||||||||||
| ReviewedField |
Indicates the Yes/No, Single-Choice, or Multi-Choice field that
Relativity monitors during a review.
A count is incremented for each document in a batch coded with a value for the specified field.
| ||||||||||
| Status |
/// Represents the status of a batch.
|
See Also