51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Core.Data.IEvidenceKeyFilter Interface Reference

Detailed Description

Represents an object that filters evidence key names based on some criteria.

For example, a filter that only included evidence items relating to HTTP headers might use key.StartsWith("header.")

Inheritance diagram for FiftyOne.Pipeline.Core.Data.IEvidenceKeyFilter:

[legend]

Public Member Functions

bool  Include (string key)
Check if the specified evidence key is included by this filter. More...
int?  Order (string key)
Get the order of precedence of the specified key More...

Member Function Documentation

◆ Include()

bool FiftyOne.Pipeline.Core.Data.IEvidenceKeyFilter.Include ( string   key )

Check if the specified evidence key is included by this filter.

Parameters
key - The key to check
Returns
True if the key is included and false if not.

Implemented in FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterWhitelist, FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsage, FiftyOne.Pipeline.Core.Data.EvidenceKeyFilterAggregator, and FiftyOne.Pipeline.Engines.FiftyOne.Data.EvidenceKeyFilterShareUsageTracker.