Skip to content

Interface: SyncIncremental<SyncContinuationT, CheckpointContinuationT>

Defined in: api_types.ts:927

Information about the current incremental sync.

Extends

Type Parameters

Type Parameter
SyncContinuationT
CheckpointContinuationT

Properties

continuation?

optional continuation: SyncContinuationT

Defined in: api_types.ts:932

The continuation that was returned from the prior sync invocation. The is the exact value returned in the continuation property of result of the prior sync.


dynamicUrl?

optional dynamicUrl: string

Defined in: api_types.ts:950

The dynamic URL that backs this sync table, if this is a dynamic sync table. The dynamic URL is likely necessary for determining which API resources to fetch.

Inherited from

SyncBase.dynamicUrl


parameters?

readonly optional parameters: MetadataContext

Defined in: api_types.ts:955

core.MetadataContext The parameters of the sync formula for the sync table.

Inherited from

SyncBase.parameters


schema?

optional schema: ArraySchema<Schema>

Defined in: api_types.ts:944

The schema of this sync table, if this is a dynamic sync table. It may be useful to have access to the dynamically-generated schema of the table instance in order to construct the response for a dynamic sync table's execute function.

Inherited from

SyncBase.schema