IDocumentDatabase.ReadTableSettingsAsync Method

Definition

Namespace:

System.Cloud.DocumentDb

Assembly:

System.Cloud.DocumentDb.Abstractions.dll

Package:

System.Cloud.DocumentDb.Abstractions v8.0.0-rc.1.23453.1

Reads the provided table settings.

public:
 System::Threading::Tasks::Task<System::Cloud::DocumentDb::IDatabaseResponse<System::Cloud::DocumentDb::TableOptions ^> ^> ^ ReadTableSettingsAsync(System::Cloud::DocumentDb::TableOptions ^ tableOptions, System::Cloud::DocumentDb::RequestOptions ^ requestOptions, System::Threading::CancellationToken cancellationToken);

public System.Threading.Tasks.Task<System.Cloud.DocumentDb.IDatabaseResponse<System.Cloud.DocumentDb.TableOptions>> ReadTableSettingsAsync(System.Cloud.DocumentDb.TableOptions tableOptions, System.Cloud.DocumentDb.RequestOptions requestOptions, System.Threading.CancellationToken cancellationToken);

abstract member ReadTableSettingsAsync : System.Cloud.DocumentDb.TableOptions * System.Cloud.DocumentDb.RequestOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Cloud.DocumentDb.IDatabaseResponse<System.Cloud.DocumentDb.TableOptions>>

Public Function ReadTableSettingsAsync (tableOptions As TableOptions, requestOptions As RequestOptions, cancellationToken As CancellationToken) As Task(Of IDatabaseResponse(Of TableOptions))

Parameters

tableOptions

TableOptions

The table options with TableName and region information provided.

requestOptions

RequestOptions

The request options.

cancellationToken

CancellationToken

The token represents the request cancellation.

Returns

Task<IDatabaseResponse<TableOptions>>

A Task containing a IDatabaseResponse<T> that wraps the table information.

Exceptions

DatabaseClientException

An error occurred on the client side, for example, on a bad request, permissions error, or client timeout.

DatabaseServerException

An error occurred on the database server side, including internal server error.

DatabaseRetryableException

The request failed but can be retried. This includes throttling and when the server is unavailable.

DatabaseException

A general failure occurred.