Search Results for

    Show / Hide Table of Contents

    Class MultiGetOperationDescriptor<T>

    Inheritance
    object
    DescriptorBase<MultiGetOperationDescriptor<T>, IMultiGetOperation>
    MultiGetOperationDescriptor<T>
    Implements
    IDescriptor
    IMultiGetOperation
    Inherited Members
    DescriptorBase<MultiGetOperationDescriptor<T>, IMultiGetOperation>.Self
    DescriptorBase<MultiGetOperationDescriptor<T>, IMultiGetOperation>.Assign<TValue>(TValue, Action<IMultiGetOperation, TValue>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class MultiGetOperationDescriptor<T> : DescriptorBase<MultiGetOperationDescriptor<T>, IMultiGetOperation>, IDescriptor, IMultiGetOperation where T : class
    Type Parameters
    Name Description
    T

    Constructors

    | Edit this page View Source

    MultiGetOperationDescriptor()

    Declaration
    public MultiGetOperationDescriptor()
    | Edit this page View Source

    MultiGetOperationDescriptor(bool)

    when rest.action.multi.allow_explicit_index is set to false you can use this constructor to generate a multiget operation with no index and type set

    See also: https://github.com/elastic/elasticsearch/issues/3636
    
    Declaration
    public MultiGetOperationDescriptor(bool allowExplicitIndex)
    Parameters
    Type Name Description
    bool allowExplicitIndex

    Methods

    | Edit this page View Source

    Id(Id)

    Declaration
    public MultiGetOperationDescriptor<T> Id(Id id)
    Parameters
    Type Name Description
    Id id
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    Index(IndexName)

    Manually set the index, default to the default index or the index set for the type on the connectionsettings.

    Declaration
    public MultiGetOperationDescriptor<T> Index(IndexName index)
    Parameters
    Type Name Description
    IndexName index
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    Routing(string)

    Set the routing for the get operation

    Declaration
    public MultiGetOperationDescriptor<T> Routing(string routing)
    Parameters
    Type Name Description
    string routing
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    Source(Func<SourceFilterDescriptor<T>, ISourceFilter>)

    Control how the document's source is loaded

    Declaration
    public MultiGetOperationDescriptor<T> Source(Func<SourceFilterDescriptor<T>, ISourceFilter> source)
    Parameters
    Type Name Description
    Func<SourceFilterDescriptor<T>, ISourceFilter> source
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    Source(bool?)

    Control how the document's source is loaded

    Declaration
    public MultiGetOperationDescriptor<T> Source(bool? sourceEnabled = true)
    Parameters
    Type Name Description
    bool? sourceEnabled
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    StoredFields(Fields)

    Declaration
    public MultiGetOperationDescriptor<T> StoredFields(Fields fields)
    Parameters
    Type Name Description
    Fields fields
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    StoredFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)

    Allows to selectively load specific fields for each document represented by a search hit. Defaults to load the internal _source field.

    Declaration
    public MultiGetOperationDescriptor<T> StoredFields(Func<FieldsDescriptor<T>, IPromise<Fields>> fields)
    Parameters
    Type Name Description
    Func<FieldsDescriptor<T>, IPromise<Fields>> fields
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    Version(long?)

    Declaration
    public MultiGetOperationDescriptor<T> Version(long? version)
    Parameters
    Type Name Description
    long? version
    Returns
    Type Description
    MultiGetOperationDescriptor<T>
    | Edit this page View Source

    VersionType(VersionType?)

    Declaration
    public MultiGetOperationDescriptor<T> VersionType(VersionType? versionType)
    Parameters
    Type Name Description
    VersionType? versionType
    Returns
    Type Description
    MultiGetOperationDescriptor<T>

    Implements

    IDescriptor
    IMultiGetOperation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • MultiGetOperationDescriptor()
      • MultiGetOperationDescriptor(bool)
    • Methods
      • Id(Id)
      • Index(IndexName)
      • Routing(string)
      • Source(Func<SourceFilterDescriptor<T>, ISourceFilter>)
      • Source(bool?)
      • StoredFields(Fields)
      • StoredFields(Func<FieldsDescriptor<T>, IPromise<Fields>>)
      • Version(long?)
      • VersionType(VersionType?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX