Class JoinProcessorDescriptor<T>

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

Inheritance
object
DescriptorBase<JoinProcessorDescriptor<T>, IJoinProcessor>
ProcessorDescriptorBase<JoinProcessorDescriptor<T>, IJoinProcessor>
JoinProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class JoinProcessorDescriptor<T> : ProcessorDescriptorBase<JoinProcessorDescriptor<T>, IJoinProcessor>, IDescriptor, IJoinProcessor, IProcessor where T : class
Type Parameters
Name Description
T

Properties

| Edit this page View Source

Name

Declaration
protected override string Name { get; }
Property Value
Type Description
string
Overrides

Methods

| Edit this page View Source

Field(Field)

The field to be joined

Declaration
public JoinProcessorDescriptor<T> Field(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
JoinProcessorDescriptor<T>
| Edit this page View Source

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

The field to be joined

Declaration
public JoinProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
JoinProcessorDescriptor<T>
Type Parameters
Name Description
TValue
| Edit this page View Source

Separator(string)

The separator character

Declaration
public JoinProcessorDescriptor<T> Separator(string separator)
Parameters
Type Name Description
string separator
Returns
Type Description
JoinProcessorDescriptor<T>
| Edit this page View Source

TargetField(Field)

The field to assign the joined value to, by default field is updated in-place

Declaration
public JoinProcessorDescriptor<T> TargetField(Field field)
Parameters
Type Name Description
Field field
Returns
Type Description
JoinProcessorDescriptor<T>
| Edit this page View Source

TargetField(Expression<Func<T, object>>)

The field to assign the joined value to, by default field is updated in-place

Declaration
public JoinProcessorDescriptor<T> TargetField(Expression<Func<T, object>> objectPath)
Parameters
Type Name Description
Expression<Func<T, object>> objectPath
Returns
Type Description
JoinProcessorDescriptor<T>

Implements

Extension Methods