Skip to main content

MGCLatticeBulkOperationResponseContract

Envelope response contract for bulk (multi-item) service operations, aggregating per-item results with overall success/failure counts, correlation tracking, and total execution timing.

Methods​

new​

Initializes a new instance of the MGCLatticeBulkOperationResponseContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeBulkOperationResponseContract class.

  • Visibility: public
  • Returns: MGCLatticeBulkOperationResponseContract A new MGCLatticeBulkOperationResponseContract instance.

No parameters.

parmSuccess​

Gets or sets the overall verdict: true only when every item succeeded (TotalCount > 0, FailureCount 0). Mirrors the single-operation contract's Success flag so a caller can check one field on either shape; before it existed clients that (reasonably) looked for Success on a bulk response always read false.

  • Visibility: public
  • Returns: boolean The overall success flag.
NameTypeOptionalDescription
_successbooleanYesThe overall success flag.

parmCorrelationId​

Gets or sets the caller-supplied correlation identifier for distributed tracing across systems.

  • Visibility: public
  • Returns: Guid The correlation GUID.
NameTypeOptionalDescription
_correlationIdGuidYesThe correlation GUID.

parmTotalCount​

Gets or sets the total number of items processed in the bulk operation.

  • Visibility: public
  • Returns: int The total processed item count.
NameTypeOptionalDescription
_totalCountintYesThe total processed item count.

parmSuccessCount​

Gets or sets the number of items that completed successfully in the bulk operation.

  • Visibility: public
  • Returns: int The successful item count.
NameTypeOptionalDescription
_successCountintYesThe successful item count.

parmFailureCount​

Gets or sets the number of items that failed in the bulk operation.

  • Visibility: public
  • Returns: int The failed item count.
NameTypeOptionalDescription
_failureCountintYesThe failed item count.

parmStartDateTimeUtc​

Gets or sets the UTC timestamp when the bulk operation began executing.

  • Visibility: public
  • Returns: utcdatetime The bulk operation start timestamp in UTC.
NameTypeOptionalDescription
_startDateTimeUtcutcdatetimeYesThe bulk operation start timestamp in UTC.

parmEndDateTimeUtc​

Gets or sets the UTC timestamp when the bulk operation finished executing.

  • Visibility: public
  • Returns: utcdatetime The bulk operation end timestamp in UTC.
NameTypeOptionalDescription
_endDateTimeUtcutcdatetimeYesThe bulk operation end timestamp in UTC.

parmDurationMs​

Gets or sets the total elapsed execution time of the bulk operation in milliseconds.

  • Visibility: public
  • Returns: int64 The elapsed time in milliseconds.
NameTypeOptionalDescription
_durationMsint64YesThe elapsed time in milliseconds.

parmResults​

Gets or sets the collection of per-item result contracts, one for each item in the bulk request.

  • Visibility: public
  • Returns: List The list of MGCLatticeBulkItemResultContract instances.
NameTypeOptionalDescription
_resultsListYesThe list of MGCLatticeBulkItemResultContract instances.

parmStatus​

Gets or sets the overall outcome of the bulk operation: Succeeded (all items ok), Failed (all items failed, or the request was invalid), or PartialSuccess (mixed).

  • Visibility: public
  • Returns: MGCLatticeServiceCallStatus The overall bulk status.
NameTypeOptionalDescription
_statusMGCLatticeServiceCallStatusYesThe overall bulk status.

parmMessage​

Gets or sets a top-level message for the bulk operation (e.g. a validation reason when the request list is missing or empty). Per-item detail remains on each result in Results.

  • Visibility: public
  • Returns: str The bulk-level message.
NameTypeOptionalDescription
_messagestrYesThe bulk-level message.