Provides the functionality for importing Artifacts into a workspace, setting import parameters, loading data, and retrieving messages from the OnMessage event.
Inheritance Hierarchy
kCura.Relativity.DataReaderClient.ImportBulkArtifactJob
Namespace: kCura.Relativity.DataReaderClient
Assembly: Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax
The ImportBulkArtifactJob type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | ImportBulkArtifactJob |
Creates a new job to import Artifacts in bulk.
|
Properties
Name | Description | |
---|---|---|
![]() | BulkLoadFileFieldDelimiter | Obsolete.
Gets or sets the field delimiter to use when writing
out the bulk load file. Line delimiters will be this value plus a line feed.
|
![]() | Settings |
Gets or sets the current settings for the import job.
|
![]() | SourceData |
Represents an instance of the SourceIDataReader, which contains data for import. This property is required.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | Execute |
Executes the DataReaderClient, which operates as an iterator over a data source.
|
![]() | ExportErrorFile |
Exports the error file for an import job. This file is written only when errors occur.
|
![]() | ExportErrorReport |
Exports the error log file for an import job. This file is written only when errors occur.
|
![]() | 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.) |
Events
Name | Description | |
---|---|---|
![]() | OnComplete |
Occurs when all the data for an import job has been processed. Raised at the end of an import.
|
![]() | OnError |
Occurs when an error is found.
|
![]() | OnFatalException |
Occurs when an import job suffers a fatal exception and aborts. Raised at the end of an import.
|
![]() | OnMessage |
Occurs when a call is made to the Execute method. This event contains a status message.
|
![]() | OnProcessProgress |
Occurs when a status message needs to be presented to the user related to the Process.
|
![]() | OnProgress |
Occurs when a record has been processed.
|
See Also