メインコンテンツまでスキップ

GetImportProgressResponse

Addedv2.6.x

This class represents the response returned by the GetImportProgress() package function. It embeds ResponseBase and exposes the detailed progress payload through ImportProgressData, which includes both overall job statistics and a per-file Details slice.

type GetImportProgressResponse struct {
ResponseBase
Data *ImportProgressData \`json:"data"\`
}

type ImportProgressData struct {
CollectionName string \`json:"collectionName"\`
JobID string \`json:"jobId"\`
CompleteTime string \`json:"completeTime"\`
State string \`json:"state"\`
Progress int64 \`json:"progress"\`
ImportedRows int64 \`json:"importedRows"\`
TotalRows int64 \`json:"totalRows"\`
Reason string \`json:"reason"\`
FileSize int64 \`json:"fileSize"\`
Details []*ImportProgressDetail \`json:"details"\`
}

type ImportProgressDetail struct {
FileName string \`json:"fileName"\`
FileSize int64 \`json:"fileSize"\`
Progress int64 \`json:"progress"\`
CompleteTime string \`json:"completeTime"\`
State string \`json:"state"\`
ImportedRows int64 \`json:"importedRows"\`
TotalRows int64 \`json:"totalRows"\`
}

FIELDS:

  • Status (int) - Inherited from ResponseBase. A value of 0 indicates success.

  • Message (string) - Inherited from ResponseBase. Error description when Status is non-zero.

  • Data (*ImportProgressData) - The progress payload for the requested job.

ImportProgressData fields:

  • CollectionName (string) - The collection the job targets.

  • JobID (string) - The unique identifier of the import job.

  • State (string) - The current job state. Common values include Pending, Importing, Completed, and Failed.

  • Progress (int64) - The overall completion percentage in the range [0, 100].

  • ImportedRows (int64) - The number of rows already imported into the collection.

  • TotalRows (int64) - The total number of rows expected from all source files.

  • FileSize (int64) - The aggregate size in bytes of all source files.

  • CompleteTime (string) - The job completion timestamp; empty until the job reaches a terminal state.

  • Reason (string) - Failure reason when State == "Failed"; empty otherwise.

  • Details ([]\ImportProgressDetail) - Per-file progress entries with the same shape as the parent fields, scoped to one source file each.