Interface IConnectionsApiClient
Interface for an API client that gets or modifies content item's connections.
Namespace: Tableau.Migration.Api
Assembly: Tableau.Migration.dll
Syntax
public interface IConnectionsApiClientMethods
GetConnectionsAsync(Guid, CancellationToken)
List the content item's connections.
Declaration
Task<IResult<ImmutableList<IConnection>>> GetConnectionsAsync(Guid contentItemId, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | contentItemId | The ID of the content item. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<ImmutableList<IConnection>>> | An immutable list of connections. |
UpdateConnectionAsync(Guid, Guid, IUpdateConnectionOptions, CancellationToken)
Update the connection on the data source.
Declaration
Task<IResult<IConnection>> UpdateConnectionAsync(Guid contentItemId, Guid connectionId, IUpdateConnectionOptions options, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | contentItemId | The ID of the content item to update connections for. |
| Guid | connectionId | The ID of the connection to be updated. |
| IUpdateConnectionOptions | options | The update connetion options. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IConnection>> |