Class ClrTypeMappingDescriptor<TDocument>

Inheritance
object
DescriptorBase<ClrTypeMappingDescriptor<TDocument>, IClrTypeMapping<TDocument>>
ClrTypeMappingDescriptor<TDocument>
Implements
IClrTypeMapping<TDocument>
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ClrTypeMappingDescriptor<TDocument> : DescriptorBase<ClrTypeMappingDescriptor<TDocument>, IClrTypeMapping<TDocument>>, IDescriptor, IClrTypeMapping<TDocument>, IClrTypeMapping where TDocument : class
Type Parameters
Name Description
TDocument

Methods

| Edit this page View Source

DisableIdInference(bool)

Disables Id inference for the given ClrType. By default, the _id value for a document is inferred from a property named Id, or from the property named by IdPropertyName, if set.

Declaration
public ClrTypeMappingDescriptor<TDocument> DisableIdInference(bool disable = true)
Parameters
Type Name Description
bool disable
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

IdProperty(Expression<Func<TDocument, object>>)

Set a default Id property on CLR type TDocument that OpenSearch.Client will evaluate

Declaration
public ClrTypeMappingDescriptor<TDocument> IdProperty(Expression<Func<TDocument, object>> property)
Parameters
Type Name Description
Expression<Func<TDocument, object>> property
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

IdProperty(string)

Set a default Id property on CLR type TDocument that OpenSearch.Client will evaluate

Declaration
public ClrTypeMappingDescriptor<TDocument> IdProperty(string property)
Parameters
Type Name Description
string property
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

Ignore(Expression<Func<TDocument, object>>)

Ignore property on CLR type TDocument

Declaration
public ClrTypeMappingDescriptor<TDocument> Ignore(Expression<Func<TDocument, object>> property)
Parameters
Type Name Description
Expression<Func<TDocument, object>> property
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

IndexName(string)

The default OpenSearch index name for TDocument

Declaration
public ClrTypeMappingDescriptor<TDocument> IndexName(string indexName)
Parameters
Type Name Description
string indexName
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

PropertyName(Expression<Func<TDocument, object>>, string)

Rename property on CLR type TDocument

Declaration
public ClrTypeMappingDescriptor<TDocument> PropertyName(Expression<Func<TDocument, object>> property, string newName)
Parameters
Type Name Description
Expression<Func<TDocument, object>> property
string newName
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

RelationName(string)

The relation name for TDocument to resolve to.

Declaration
public ClrTypeMappingDescriptor<TDocument> RelationName(string relationName)
Parameters
Type Name Description
string relationName
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>
| Edit this page View Source

RoutingProperty(Expression<Func<TDocument, object>>)

Provide a default routing parameter lookup based on TDocument

Declaration
public ClrTypeMappingDescriptor<TDocument> RoutingProperty(Expression<Func<TDocument, object>> property)
Parameters
Type Name Description
Expression<Func<TDocument, object>> property
Returns
Type Description
ClrTypeMappingDescriptor<TDocument>

Implements

Extension Methods