Skip to main content
Version: v1

ISummaryNack Interface

Contents of summary nack expected from the server.

Signature​

export interface ISummaryNack

Properties​

PropertyModifiersTypeDescription
codeoptionalnumberAn error code number that represents the error. It will be a valid HTTP error code. 403 errors are non retryable. 400 errors are always immediately retriable. 429 errors are retriable or non retriable (depends on type field).
messageoptionalstringA message about the error for debugging/logging/telemetry purposes
retryAfteroptionalnumberOptional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying.8
summaryProposalISummaryProposalInformation about the proposed summary op.

Property Details​

code​

An error code number that represents the error. It will be a valid HTTP error code. 403 errors are non retryable. 400 errors are always immediately retriable. 429 errors are retriable or non retriable (depends on type field).

Signature​

code?: number;

Type: number

message​

A message about the error for debugging/logging/telemetry purposes

Signature​

message?: string;

Type: string

retryAfter​

Optional Retry-After time in seconds. If specified, the client should wait this many seconds before retrying.8

Signature​

retryAfter?: number;

Type: number

summaryProposal​

Information about the proposed summary op.

Signature​

summaryProposal: ISummaryProposal;

Type: ISummaryProposal