Class GetFieldMappingResponse

Inheritance
object
ResponseBase
DictionaryResponseBase<IndexName, TypeFieldMappings>
GetFieldMappingResponse
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetFieldMappingResponse : DictionaryResponseBase<IndexName, TypeFieldMappings>, IDictionaryResponse<IndexName, TypeFieldMappings>, IResponse, IOpenSearchResponse

Properties

| Edit this page View Source

Indices

Declaration
[IgnoreDataMember]
public IReadOnlyDictionary<IndexName, TypeFieldMappings> Indices { get; }
Property Value
Type Description
IReadOnlyDictionary<IndexName, TypeFieldMappings>
| Edit this page View Source

IsValid

Checks if a response is functionally valid or not. This is a OpenSearch.Client abstraction to have a single property to check whether there was something wrong with a request.

For instance, an OpenSearch bulk response always returns 200 and individual bulk items may fail, IsValid will be false in that case.

You can also configure the client to always throw an OpenSearchClientException using ThrowExceptions if the response is not valid

Declaration
public override bool IsValid { get; }
Property Value
Type Description
bool
Overrides

Methods

| Edit this page View Source

GetMapping(IndexName, Field)

Declaration
public IFieldMapping GetMapping(IndexName index, Field property)
Parameters
Type Name Description
IndexName index
Field property
Returns
Type Description
IFieldMapping
| Edit this page View Source

MappingFor<T>(Field)

Declaration
public IFieldMapping MappingFor<T>(Field property)
Parameters
Type Name Description
Field property
Returns
Type Description
IFieldMapping
Type Parameters
Name Description
T
| Edit this page View Source

MappingFor<T>(Field, IndexName)

Declaration
public IFieldMapping MappingFor<T>(Field property, IndexName index)
Parameters
Type Name Description
Field property
IndexName index
Returns
Type Description
IFieldMapping
Type Parameters
Name Description
T
| Edit this page View Source

MappingFor<T>(Expression<Func<T, object>>, IndexName)

Declaration
public IFieldMapping MappingFor<T>(Expression<Func<T, object>> objectPath, IndexName index = null) where T : class
Parameters
Type Name Description
Expression<Func<T, object>> objectPath
IndexName index
Returns
Type Description
IFieldMapping
Type Parameters
Name Description
T
| Edit this page View Source

MappingFor<T, TValue>(Expression<Func<T, TValue>>, IndexName)

Declaration
public IFieldMapping MappingFor<T, TValue>(Expression<Func<T, TValue>> objectPath, IndexName index = null) where T : class
Parameters
Type Name Description
Expression<Func<T, TValue>> objectPath
IndexName index
Returns
Type Description
IFieldMapping
Type Parameters
Name Description
T
TValue

Implements

Extension Methods