Class AssetSearchFilter

A structure for defining the criteria of an IAsset search request.

Inheritance

object

AssetSearchFilter

Implements

IAssetSearchFilter

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 AssetSearchFilter : IAssetSearchFilter

Properties

Collections

Sets the collections the search criteria will be applied to.

Declaration

public QueryListParameter<CollectionPath> Collections { get; }

Property Value

Type	Description
QueryListParameter<CollectionPath>

Methods

AccumulateAnyCriteria()

Gets the optional search criteria of the filter.

Declaration

public (IReadOnlyDictionary<string, object> criteria, int minimumMatches) AccumulateAnyCriteria()

Returns

Type	Description
(IReadOnlyDictionary<string, object> criteria, int minimumMatches)	A dictionary containing the optional search criteria and the minimum matches required to statisfy the condition.

AccumulateExcludedCriteria()

Gets the excluded search criteria of the filter.

Declaration

public IReadOnlyDictionary<string, object> AccumulateExcludedCriteria()

Returns

Type	Description
IReadOnlyDictionary<string, object>	A dictionary containing the excluded search criteria.

AccumulateIncludedCriteria()

Gets the required search criteria of the filter.

Declaration

public IReadOnlyDictionary<string, object> AccumulateIncludedCriteria()

Returns

Type	Description
IReadOnlyDictionary<string, object>	A dictionary containing the required search criteria.

Any()

Any properties populated here will be considered when searching for assets. The minimum number of matches required can be set using MinimumMatch.

Declaration

public AssetSearchCriteriaWithMinimumMatch Any()

Returns

Type	Description
AssetSearchCriteriaWithMinimumMatch

Exclude()

All properties populated here will be considered for exact matching when excluding assets.

Declaration

public AssetSearchCriteria Exclude()

Returns

Type	Description
AssetSearchCriteria

Include()

All properties populated here will be considered for exact matching when searching for assets.

Declaration

public AssetSearchCriteria Include()

Returns

Type	Description
AssetSearchCriteria

Implements

IAssetSearchFilter