Interface INameSearchApiClient<TContent>
Interface for an API client that can search for content items by name.
Inherited Members
Namespace: Tableau.Migration.Api
Assembly: Tableau.Migration.dll
Syntax
public interface INameSearchApiClient<TContent> : IFilteredPagedListApiClient<TContent>, IPagedListApiClient<TContent>Type Parameters
| Name | Description |
|---|---|
| TContent | The content type. |
Properties
NameFilterOperator
Gets the filter operator to use for SearchByNameAsync(string, int, CancellationToken).
Declaration
FilterOperator NameFilterOperator { get; }Property Value
| Type | Description |
|---|---|
| FilterOperator |
Methods
SearchByNameAsync(string, int, CancellationToken)
Finds the content items with the given name. Multiple items will be returned if multiple items have the same name but different ContentLocation.
Declaration
Task<IResult<IImmutableList<TContent>>> SearchByNameAsync(string name, int pageSize, CancellationToken cancel)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name to search for. |
| int | pageSize | The expected maximum number of items to include in each page. |
| CancellationToken | cancel | The cancellation token to obey. |
Returns
| Type | Description |
|---|---|
| Task<IResult<IImmutableList<TContent>>> | The result of the search operation with the found items. |