Interface IConnectionSettingsValues

Provides the connection settings for OpenSearchClient

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IConnectionSettingsValues : IConnectionConfigurationValues, IDisposable

Properties

| Edit this page View Source

DefaultDisableIdInference

Disables automatic Id inference for all CLR types.

OpenSearch.Client by default will use the value of a property named Id on a CLR type as the _id to send to OpenSearch. Setting this to true will disable this behaviour for all CLR types and cannot be overridden. If Id inference should be disabled only for specific types, use DisableIdInference
Declaration
bool DefaultDisableIdInference { get; }
Property Value
Type Description
bool
| Edit this page View Source

DefaultFieldNameInferrer

Specifies how field names are inferred from CLR property names.

By default, OpenSearch.Client camel cases property names.
Declaration
Func<string, string> DefaultFieldNameInferrer { get; }
Property Value
Type Description
Func<string, string>
Examples

CLR property EmailAddress will be inferred as "emailAddress" OpenSearch document field name

| Edit this page View Source

DefaultIndex

The default index to use for a request when no index has been explicitly specified and no default indices are specified for the given CLR type specified for the request.

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

DefaultIndices

The default index/indices to use for a request for a given CLR type specified in the request.

Declaration
FluentDictionary<Type, string> DefaultIndices { get; }
Property Value
Type Description
FluentDictionary<Type, string>
| Edit this page View Source

DefaultRelationNames

The default relation name to use for a request for a given CLR type specified in the request.

Declaration
FluentDictionary<Type, string> DefaultRelationNames { get; }
Property Value
Type Description
FluentDictionary<Type, string>
| Edit this page View Source

DisableIdInference

Disables automatic Id inference for given CLR types.

OpenSearch.Client by default will use the value of a property named Id on a CLR type as the _id to send to OpenSearch. Adding a type will disable this behaviour for that CLR type. If Id inference should be disabled for all CLR types, use DefaultDisableIdInference
Declaration
HashSet<Type> DisableIdInference { get; }
Property Value
Type Description
HashSet<Type>
| Edit this page View Source

IdProperties

Specify a property for a CLR type to use to infer the _id of the document when indexed in OpenSearch.

Declaration
FluentDictionary<Type, string> IdProperties { get; }
Property Value
Type Description
FluentDictionary<Type, string>
| Edit this page View Source

Inferrer

Infers index, type, id, relation, routing and field names

Declaration
Inferrer Inferrer { get; }
Property Value
Type Description
Inferrer
| Edit this page View Source

PropertyMappingProvider

Provides mappings for CLR types

Declaration
IPropertyMappingProvider PropertyMappingProvider { get; }
Property Value
Type Description
IPropertyMappingProvider
| Edit this page View Source

PropertyMappings

Provides mappings for CLR type members

Declaration
FluentDictionary<MemberInfo, IPropertyMapping> PropertyMappings { get; }
Property Value
Type Description
FluentDictionary<MemberInfo, IPropertyMapping>
| Edit this page View Source

RouteProperties

Specify a property for a CLR type to use to infer the routing for of a document when indexed in OpenSearch.

Declaration
FluentDictionary<Type, string> RouteProperties { get; }
Property Value
Type Description
FluentDictionary<Type, string>
| Edit this page View Source

SourceSerializer

The serializer use to serialize CLR types representing documents and other types related to documents.

Declaration
IOpenSearchSerializer SourceSerializer { get; }
Property Value
Type Description
IOpenSearchSerializer

Extension Methods