Method GetIndexAsync
GetIndexAsync(String, String, GetIndexOptions, CancellationToken)
Retrieves the information about specific index of the table.
Declaration
public Task<IndexResult> GetIndexAsync(string tableName, string indexName, GetIndexOptions options = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
String | tableName | Name of the table. |
String | indexName | Name of the index. |
GetIndexOptions | options | (Optional) Options for this operation. If
not specified or null , appropriate defaults will
be used. |
CancellationToken | cancellationToken | (Optional) Cancellation token. |
Returns
Type | Description |
---|---|
Task<IndexResult> | Task returning IndexResult object. |
Remarks
This information is retrieved as IndexResult
object. If provided index name is not found,
IndexNotFoundException is thrown.
Exceptions
Type | Condition |
---|---|
ArgumentException | If
tableName is null or invalid
or indexName is null or
invalid or options contains invalid values.
|
TimeoutException | Operation has timed out. |
InvalidOperationException | The table or service is not in a valid state to perform this operation. |
NoSQLException | NoSQLException or one of its subclasses is thrown if operation cannot be performed for any other reason. See documentation for corresponding subclass of NoSQLException. |