Class PropertyBase

A mapping for a property type to a document field in OpenSearch

Inheritance
object
PropertyBase
CorePropertyBase
FieldAliasProperty
JoinProperty
PercolatorProperty
RankFeatureProperty
RankFeaturesProperty
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public abstract class PropertyBase : IProperty, IFieldMapping, IPropertyWithClrOrigin

Constructors

| Edit this page View Source

PropertyBase(FieldType)

Declaration
protected PropertyBase(FieldType type)
Parameters
Type Name Description
FieldType type

Properties

| Edit this page View Source

DebugDisplay

Declaration
protected string DebugDisplay { get; }
Property Value
Type Description
string
| Edit this page View Source

LocalMetadata

Local property metadata that will not be stored in OpenSearch with the mappings

Declaration
public IDictionary<string, object> LocalMetadata { get; set; }
Property Value
Type Description
IDictionary<string, object>
| Edit this page View Source

Meta

Metadata attached to the field. This metadata is stored in but opaque to OpenSearch. It is only useful for multiple applications that work on the same indices to share meta information about fields such as units.

Field metadata enforces at most 5 entries, that keys have a length that is less than or equal to 20, and that values are strings whose length is less than or equal to 50.

Declaration
public IDictionary<string, string> Meta { get; set; }
Property Value
Type Description
IDictionary<string, string>
| Edit this page View Source

Name

The name of the property

Declaration
public PropertyName Name { get; set; }
Property Value
Type Description
PropertyName
| Edit this page View Source

TypeOverride

Override for the property type, used for custom mappings

Declaration
protected string TypeOverride { get; set; }
Property Value
Type Description
string

Methods

| Edit this page View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods