Interface IProperty

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

Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IProperty : IFieldMapping

Properties

| Edit this page View Source

LocalMetadata

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

Declaration
[IgnoreDataMember]
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
[DataMember(Name = "meta")]
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
[IgnoreDataMember]
PropertyName Name { get; set; }
Property Value
Type Description
PropertyName
| Edit this page View Source

Type

The datatype of the property

Declaration
[DataMember(Name = "type")]
string Type { get; set; }
Property Value
Type Description
string

Extension Methods