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:
MGCLatticeBulkOperationResponseContractA 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:
booleanThe overall success flag.
| Name | Type | Optional | Description |
|---|---|---|---|
_success | boolean | Yes | The overall success flag. |
parmCorrelationId
Gets or sets the caller-supplied correlation identifier for distributed tracing across systems.
- Visibility:
public - Returns:
GuidThe correlation GUID.
| Name | Type | Optional | Description |
|---|---|---|---|
_correlationId | Guid | Yes | The correlation GUID. |
parmTotalCount
Gets or sets the total number of items processed in the bulk operation.
- Visibility:
public - Returns:
intThe total processed item count.
| Name | Type | Optional | Description |
|---|---|---|---|
_totalCount | int | Yes | The total processed item count. |
parmSuccessCount
Gets or sets the number of items that completed successfully in the bulk operation.
- Visibility:
public - Returns:
intThe successful item count.
| Name | Type | Optional | Description |
|---|---|---|---|
_successCount | int | Yes | The successful item count. |
parmFailureCount
Gets or sets the number of items that failed in the bulk operation.
- Visibility:
public - Returns:
intThe failed item count.
| Name | Type | Optional | Description |
|---|---|---|---|
_failureCount | int | Yes | The failed item count. |
parmStartDateTimeUtc
Gets or sets the UTC timestamp when the bulk operation began executing.
- Visibility:
public - Returns:
utcdatetimeThe bulk operation start timestamp in UTC.
| Name | Type | Optional | Description |
|---|---|---|---|
_startDateTimeUtc | utcdatetime | Yes | The bulk operation start timestamp in UTC. |
parmEndDateTimeUtc
Gets or sets the UTC timestamp when the bulk operation finished executing.
- Visibility:
public - Returns:
utcdatetimeThe bulk operation end timestamp in UTC.
| Name | Type | Optional | Description |
|---|---|---|---|
_endDateTimeUtc | utcdatetime | Yes | The bulk operation end timestamp in UTC. |
parmDurationMs
Gets or sets the total elapsed execution time of the bulk operation in milliseconds.
- Visibility:
public - Returns:
int64The elapsed time in milliseconds.
| Name | Type | Optional | Description |
|---|---|---|---|
_durationMs | int64 | Yes | The 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:
ListThe list of MGCLatticeBulkItemResultContract instances.
| Name | Type | Optional | Description |
|---|---|---|---|
_results | List | Yes | The 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:
MGCLatticeServiceCallStatusThe overall bulk status.
| Name | Type | Optional | Description |
|---|---|---|---|
_status | MGCLatticeServiceCallStatus | Yes | The 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:
strThe bulk-level message.
| Name | Type | Optional | Description |
|---|---|---|---|
_message | str | Yes | The bulk-level message. |