Interface IRestRequestBuilder

Interface for a class that can build REST API requests.

Inherited Members

IRequestBuilder<IRestRequestBuilder>.WithQuery(Action<IQueryStringBuilder>)

IRequestBuilder<IRestRequestBuilder>.WithQuery(string, string)

IRequestBuilder.ForDeleteRequest()

IRequestBuilder.ForGetRequest()

IRequestBuilder.ForPatchRequest()

IRequestBuilder.ForPostRequest()

IRequestBuilder.ForPutRequest()

Namespace: Tableau.Migration.Net.Rest

Assembly: Tableau.Migration.dll

Syntax

public interface IRestRequestBuilder : IRequestBuilder<IRestRequestBuilder>, IRequestBuilder

Methods

WithApiVersion(string)

Sets the URI's version segment, i.e. "/api/".

Declaration

IRestRequestBuilder WithApiVersion(string apiVersion)

Parameters

Type	Name	Description
string	apiVersion	The REST API version.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithFields(Action<IFieldBuilder>)

Configures the fields for the URI.

Declaration

IRestRequestBuilder WithFields(Action<IFieldBuilder> fields)

Parameters

Type	Name	Description
Action<IFieldBuilder>	fields	The callback used to build the URI's fields query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithFields(params Field[])

Configures the fields for the URI.

Declaration

IRestRequestBuilder WithFields(params Field[] fields)

Parameters

Type	Name	Description
Field[]	fields	The fields used to build the URI's fields query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithFilters(Action<IFilterBuilder>)

Configures the filters for the URI.

Declaration

IRestRequestBuilder WithFilters(Action<IFilterBuilder> filters)

Parameters

Type	Name	Description
Action<IFilterBuilder>	filters	The callback used to build the URI's filter query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithFilters(IEnumerable<Filter>)

Configures the filters for the URI.

Declaration

IRestRequestBuilder WithFilters(IEnumerable<Filter> filters)

Parameters

Type	Name	Description
IEnumerable<Filter>	filters	The filters used to build the URI's filter query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithFilters(params Filter[])

Configures the filters for the URI.

Declaration

IRestRequestBuilder WithFilters(params Filter[] filters)

Parameters

Type	Name	Description
Filter[]	filters	The filters used to build the URI's filter query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithPage(Action<IPageBuilder>)

Configures the page for the URI.

Declaration

IRestRequestBuilder WithPage(Action<IPageBuilder> paging)

Parameters

Type	Name	Description
Action<IPageBuilder>	paging	The callback used to build the URI's page query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithPage(int, int)

Configures the page for the URI.

Declaration

IRestRequestBuilder WithPage(int pageNumber, int pageSize)

Parameters

Type	Name	Description
int	pageNumber	The 1-indexed page number for the page.
int	pageSize	The expected maximum number of items to include in the page.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithPage(Page)

Configures the page for the URI.

Declaration

IRestRequestBuilder WithPage(Page page)

Parameters

Type	Name	Description
Page	page	The page used to build the URI's filter query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithSiteId(Guid)

Sets the the URI's sites segment, i.e. "/sites/".

Declaration

IRestRequestBuilder WithSiteId(Guid siteId)

Parameters

Type	Name	Description
Guid	siteId	The site's ID.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithSiteId(string?)

Sets the the URI's sites segment, i.e. "/sites/".

Declaration

IRestRequestBuilder WithSiteId(string? siteId)

Parameters

Type	Name	Description
string	siteId	The site's ID.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithSorts(Action<ISortBuilder>)

Configures the sorts for the URI.

Declaration

IRestRequestBuilder WithSorts(Action<ISortBuilder> sorts)

Parameters

Type	Name	Description
Action<ISortBuilder>	sorts	The callback used to build the URI's sort query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.

WithSorts(params Sort[])

Configures the sorts for the URI.

Declaration

IRestRequestBuilder WithSorts(params Sort[] sorts)

Parameters

Type	Name	Description
Sort[]	sorts	The callback used to build the URI's sort query string.

Returns

Type	Description
IRestRequestBuilder	The current IRestRequestBuilder instance.