Class RenameProcessorDescriptor<T>

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

Inheritance
object
DescriptorBase<RenameProcessorDescriptor<T>, IRenameProcessor>
ProcessorDescriptorBase<RenameProcessorDescriptor<T>, IRenameProcessor>
RenameProcessorDescriptor<T>
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class RenameProcessorDescriptor<T> : ProcessorDescriptorBase<RenameProcessorDescriptor<T>, IRenameProcessor>, IDescriptor, IRenameProcessor, 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 renamed. Supports template snippets.

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

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

The field to be renamed. Supports template snippets.

Declaration
public RenameProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
Returns
Type Description
RenameProcessorDescriptor<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 RenameProcessorDescriptor<T> IgnoreMissing(bool? ignoreMissing = true)
Parameters
Type Name Description
bool? ignoreMissing
Returns
Type Description
RenameProcessorDescriptor<T>
| Edit this page View Source

TargetField(Field)

The new name of the field. Supports template snippets.

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

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

The new name of the field. Supports template snippets.

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

Implements

Extension Methods