Class TermsInclude

Filters which terms to include in the response

Inheritance

object

TermsInclude

Inherited Members

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 TermsInclude

Constructors

TermsInclude(IEnumerable<string>)

Creates an instance of TermsInclude that uses a collection of terms to include in the response

Declaration

public TermsInclude(IEnumerable<string> values)

Parameters

Type	Name	Description
IEnumerable<string>	values	The exact terms to include

TermsInclude(long, long)

Creates an instance of TermsInclude that partitions the terms into a number of partitions to receive in multiple requests. Used to process many unique terms

Declaration

public TermsInclude(long partition, long numberOfPartitions)

Parameters

Type	Name	Description
long	partition	The 0-based partition number for this request
long	numberOfPartitions	The total number of partitions

TermsInclude(string)

Creates an instance of TermsInclude that uses a regular expression pattern to determine the terms to include in the response

Declaration

public TermsInclude(string pattern)

Parameters

Type	Name	Description
string	pattern	The regular expression pattern

Properties

NumberOfPartitions

The total number of partitions we are interested in

Declaration

[DataMember(Name = "num_partitions")]
public long? NumberOfPartitions { get; set; }

Property Value

Type	Description
long?

Partition

The current partition of terms we are interested in

Declaration

[DataMember(Name = "partition")]
public long? Partition { get; set; }

Property Value

Type	Description
long?

Pattern

The regular expression pattern to determine terms to include in the response

Declaration

[IgnoreDataMember]
public string Pattern { get; set; }

Property Value

Type	Description
string

Values

Collection of terms to include in the response

Declaration

[IgnoreDataMember]
public IEnumerable<string> Values { get; set; }

Property Value

Type	Description
IEnumerable<string>

Extension Methods

SuffixExtensions.Suffix(object, string)