Property TablePollTimeout
TablePollTimeout
Declaration
public Nullable<TimeSpan> TablePollTimeout { get; set; }
Property Value
Type | Description |
---|---|
Nullable<TimeSpan> | Timeout to wait for completion of a table DDL operation. If not set, the default is no timeout (infinity). |
Remarks
Methods WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) and WaitForTableStateAsync(String, TableState, TableCompletionOptions, CancellationToken) wait for completion of a table DDL operation by polling the table for status at regular intervals. This property sets a timeout on the duration of the calls to WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) and WaitForTableStateAsync(String, TableState, TableCompletionOptions, CancellationToken). Set this property to limit the duration of these polling operations. Because table DDL operations may be potentially long running, there is no default timeout.
This property serves as a default for WaitForCompletionAsync(Nullable<TimeSpan>, Nullable<TimeSpan>, CancellationToken) if the timeout parameter is not provided as well as the default for WaitForTableStateAsync(String, TableState, TableCompletionOptions, CancellationToken) if the timeout is not set in TableCompletionOptions.
If Timeout is not set, the value of this property is added to the the default timeout for ExecuteTableDDLWithCompletionAsync and SetTableLimitsWithCompletionAsync(String, TableLimits, TableDDLOptions, CancellationToken) APIs because these operations already include the polling for the table status. If this property is not set, these operations will likewise have no timeout.