Class FieldDefinitionQueryBuilder

A class that builds and executes a query to return a set of field definitions.

Inheritance

object

FieldDefinitionQueryBuilder

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Cloud.Assets

Assembly: Unity.Cloud.Assets.dll

Syntax

public class FieldDefinitionQueryBuilder

Methods

ExecuteAsync(CancellationToken)

Executes the query and returns the results.

Declaration

public IAsyncEnumerable<IFieldDefinition> ExecuteAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
IAsyncEnumerable<IFieldDefinition>	An async enumeration of IFieldDefinition.

LimitTo(Range)

Sets the range of results to return.

Declaration

public FieldDefinitionQueryBuilder LimitTo(Range range)

Parameters

Type	Name	Description
Range	range	The range of results to return.

Returns

Type	Description
FieldDefinitionQueryBuilder	The calling FieldDefinitionQueryBuilder.

OrderByName(SortingOrder)

Sets the order in which the results will be returned.

Declaration

public FieldDefinitionQueryBuilder OrderByName(SortingOrder sortingOrder)

Parameters

Type	Name	Description
SortingOrder	sortingOrder	The sorting order (Ascending|Descending).

Returns

Type	Description
FieldDefinitionQueryBuilder	The calling FieldDefinitionQueryBuilder.

SelectWhereMatchesFilter(FieldDefinitionSearchFilter)

Sets the filter to use for the query.

Declaration

public FieldDefinitionQueryBuilder SelectWhereMatchesFilter(FieldDefinitionSearchFilter searchFilter)

Parameters

Type	Name	Description
FieldDefinitionSearchFilter	searchFilter	The search criteria.

Returns

Type	Description
FieldDefinitionQueryBuilder	The calling FieldDefinitionQueryBuilder.

WithCacheConfiguration(FieldDefinitionCacheConfiguration)

Sets an override to the default cache configuration for the query.

Declaration

public FieldDefinitionQueryBuilder WithCacheConfiguration(FieldDefinitionCacheConfiguration fieldDefinitionCacheConfiguration)

Parameters

Type	Name	Description
FieldDefinitionCacheConfiguration	fieldDefinitionCacheConfiguration	The configuration to apply when populating the field definitions.

Returns

Type	Description
FieldDefinitionQueryBuilder	The calling FieldDefinitionQueryBuilder.