MGCLatticeAsyncOperationResponseContract
Response of submitAsyncOperation: the tracking identifier to poll with getAsyncOperationStatus, or the reason the submission was refused. Repeating a submission with the same RequestId returns the tracking identifier of the first submission instead of queueing the operation again.
Methods
new
Initializes a new instance of the MGCLatticeAsyncOperationResponseContract class.
- Visibility:
public - Returns:
void
No parameters.
construct
Creates a new instance of the MGCLatticeAsyncOperationResponseContract class.
- Visibility:
public - Returns:
MGCLatticeAsyncOperationResponseContractA new MGCLatticeAsyncOperationResponseContract instance.
No parameters.
parmSuccess
True when the operation is queued (or was already queued by an earlier submission with the same RequestId).
- Visibility:
public - Returns:
booleanThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_success | boolean | Yes | The value to set. |
parmTrackingId
The tracking identifier to poll with getAsyncOperationStatus.
- Visibility:
public - Returns:
GuidThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_trackingId | Guid | Yes | The value to set. |
parmStatus
Queued for a new submission; the current state for a repeated RequestId; Failed when the submission was refused.
- Visibility:
public - Returns:
MGCLatticeAsyncOperationStatusThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_status | MGCLatticeAsyncOperationStatus | Yes | The value to set. |
parmErrorCode
Why the submission was refused; None when it succeeded.
- Visibility:
public - Returns:
MGCLatticeServiceErrorCodeThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_errorCode | MGCLatticeServiceErrorCode | Yes | The value to set. |
parmIsRetryable
Whether a refused submission can be retried unchanged (for example after a license renewal).
- Visibility:
public - Returns:
booleanThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_isRetryable | boolean | Yes | The value to set. |
parmMessage
The human-readable result message.
- Visibility:
public - Returns:
strThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_message | str | Yes | The value to set. |
parmCorrelationId
The correlation identifier of the submission.
- Visibility:
public - Returns:
GuidThe current value.
| Name | Type | Optional | Description |
|---|---|---|---|
_correlationId | Guid | Yes | The value to set. |