Class HighlightFieldDescriptor<T>

Inheritance

object

DescriptorBase<HighlightFieldDescriptor<T>, IHighlightField>

HighlightFieldDescriptor<T>

Implements

IDescriptor

IHighlightField

Inherited Members

DescriptorBase<HighlightFieldDescriptor<T>, IHighlightField>.Self

DescriptorBase<HighlightFieldDescriptor<T>, IHighlightField>.Assign<TValue>(TValue, Action<IHighlightField, TValue>)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class HighlightFieldDescriptor<T> : DescriptorBase<HighlightFieldDescriptor<T>, IHighlightField>, IDescriptor, IHighlightField where T : class

Type Parameters

Name	Description
T

Methods

| Edit this page View Source

AllField()

Declaration

public HighlightFieldDescriptor<T> AllField()

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

BoundaryCharacters(string)

Declaration

public HighlightFieldDescriptor<T> BoundaryCharacters(string boundaryCharacters)

Parameters

Type	Name	Description
string	boundaryCharacters

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

BoundaryMaxScan(int?)

Declaration

public HighlightFieldDescriptor<T> BoundaryMaxScan(int? boundaryMaxSize)

Parameters

Type	Name	Description
int?	boundaryMaxSize

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

BoundaryScanner(BoundaryScanner?)

Declaration

public HighlightFieldDescriptor<T> BoundaryScanner(BoundaryScanner? boundaryScanner)

Parameters

Type	Name	Description
BoundaryScanner?	boundaryScanner

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

BoundaryScannerLocale(string)

Declaration

public HighlightFieldDescriptor<T> BoundaryScannerLocale(string locale)

Parameters

Type	Name	Description
string	locale

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

Field(Field)

Declaration

public HighlightFieldDescriptor<T> Field(Field field)

Parameters

Type	Name	Description
Field	field

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

Field<TValue>(Expression<Func<T, TValue>>)

Declaration

public HighlightFieldDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)

Parameters

Type	Name	Description
Expression<Func<T, TValue>>	objectPath

Returns

Type	Description
HighlightFieldDescriptor<T>

Type Parameters

Name	Description
TValue

| Edit this page View Source

ForceSource(bool?)

Declaration

public HighlightFieldDescriptor<T> ForceSource(bool? force = true)

Parameters

Type	Name	Description
bool?	force

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

FragmentOffset(int?)

Declaration

public HighlightFieldDescriptor<T> FragmentOffset(int? fragmentOffset)

Parameters

Type	Name	Description
int?	fragmentOffset

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

FragmentSize(int?)

Declaration

public HighlightFieldDescriptor<T> FragmentSize(int? fragmentSize)

Parameters

Type	Name	Description
int?	fragmentSize

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

Fragmenter(HighlighterFragmenter?)

Declaration

public HighlightFieldDescriptor<T> Fragmenter(HighlighterFragmenter? fragmenter)

Parameters

Type	Name	Description
HighlighterFragmenter?	fragmenter

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

HighlightQuery(Func<QueryContainerDescriptor<T>, QueryContainer>)

Declaration

public HighlightFieldDescriptor<T> HighlightQuery(Func<QueryContainerDescriptor<T>, QueryContainer> querySelector)

Parameters

Type	Name	Description
Func<QueryContainerDescriptor<T>, QueryContainer>	querySelector

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

MatchedFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

Declaration

public HighlightFieldDescriptor<T> MatchedFields(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)

Parameters

Type	Name	Description
Func<FieldsDescriptor<T>, IPromise<Fields>>	fields

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

MaxAnalyzerOffset(int?)

Declaration

public HighlightFieldDescriptor<T> MaxAnalyzerOffset(int? maxAnalyzerOffset)

Parameters

Type	Name	Description
int?	maxAnalyzerOffset

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

MaxFragmentLength(int?)

Declaration

public HighlightFieldDescriptor<T> MaxFragmentLength(int? maxFragmentLength)

Parameters

Type	Name	Description
int?	maxFragmentLength

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

NoMatchSize(int?)

Declaration

public HighlightFieldDescriptor<T> NoMatchSize(int? noMatchSize)

Parameters

Type	Name	Description
int?	noMatchSize

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

NumberOfFragments(int?)

Declaration

public HighlightFieldDescriptor<T> NumberOfFragments(int? numberOfFragments)

Parameters

Type	Name	Description
int?	numberOfFragments

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

Order(HighlighterOrder?)

Declaration

public HighlightFieldDescriptor<T> Order(HighlighterOrder? order)

Parameters

Type	Name	Description
HighlighterOrder?	order

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

PhraseLimit(int?)

Declaration

public HighlightFieldDescriptor<T> PhraseLimit(int? phraseLimit)

Parameters

Type	Name	Description
int?	phraseLimit

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

PostTags(IEnumerable<string>)

Declaration

public HighlightFieldDescriptor<T> PostTags(IEnumerable<string> postTags)

Parameters

Type	Name	Description
IEnumerable<string>	postTags

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

PostTags(params string[])

Declaration

public HighlightFieldDescriptor<T> PostTags(params string[] postTags)

Parameters

Type	Name	Description
string[]	postTags

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

PreTags(IEnumerable<string>)

Declaration

public HighlightFieldDescriptor<T> PreTags(IEnumerable<string> preTags)

Parameters

Type	Name	Description
IEnumerable<string>	preTags

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

PreTags(params string[])

Declaration

public HighlightFieldDescriptor<T> PreTags(params string[] preTags)

Parameters

Type	Name	Description
string[]	preTags

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

RequireFieldMatch(bool?)

Declaration

public HighlightFieldDescriptor<T> RequireFieldMatch(bool? requireFieldMatch = true)

Parameters

Type	Name	Description
bool?	requireFieldMatch

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

TagsSchema(HighlighterTagsSchema?)

Declaration

public HighlightFieldDescriptor<T> TagsSchema(HighlighterTagsSchema? schema)

Parameters

Type	Name	Description
HighlighterTagsSchema?	schema

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

Type(HighlighterType)

Declaration

public HighlightFieldDescriptor<T> Type(HighlighterType type)

Parameters

Type	Name	Description
HighlighterType	type

Returns

Type	Description
HighlightFieldDescriptor<T>

| Edit this page View Source

Type(string)

Declaration

public HighlightFieldDescriptor<T> Type(string type)

Parameters

Type	Name	Description
string	type

Returns

Type	Description
HighlightFieldDescriptor<T>

Implements

IDescriptor

IHighlightField

Extension Methods

SuffixExtensions.Suffix(object, string)