Class GsubProcessorDescriptor<T>

Converts a string field by applying a regular expression and a replacement. If the field is not a string, the processor will throw an exception.

Inheritance
object
DescriptorBase<GsubProcessorDescriptor<T>, IGsubProcessor>
ProcessorDescriptorBase<GsubProcessorDescriptor<T>, IGsubProcessor>
GsubProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GsubProcessorDescriptor<T> : ProcessorDescriptorBase<GsubProcessorDescriptor<T>, IGsubProcessor>, IDescriptor, IGsubProcessor, 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 apply the replacement to

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

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

The field to apply the replacement to

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

IgnoreMissing(bool?)

If true and Field does not exist or is null, the processor quietly exits without modifying the document. Default is false

Declaration
public GsubProcessorDescriptor<T> IgnoreMissing(bool? ignoreMissing = true)
Parameters
Type Name Description
bool? ignoreMissing
Returns
Type Description
GsubProcessorDescriptor<T>
| Edit this page View Source

Pattern(string)

The pattern to be replaced

Declaration
public GsubProcessorDescriptor<T> Pattern(string pattern)
Parameters
Type Name Description
string pattern
Returns
Type Description
GsubProcessorDescriptor<T>
| Edit this page View Source

Replacement(string)

The string to replace the matching patterns with

Declaration
public GsubProcessorDescriptor<T> Replacement(string replacement)
Parameters
Type Name Description
string replacement
Returns
Type Description
GsubProcessorDescriptor<T>
| Edit this page View Source

TargetField(Field)

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

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

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

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

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

Implements

Extension Methods