Search Results for

    Show / Hide Table of Contents

    Class SourceDescriptor<TDocument>

    Descriptor for Source

    https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/

    Inheritance
    object
    RequestBase<SourceRequestParameters>
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>
    SourceDescriptor<TDocument>
    Implements
    IDescriptor
    ISourceRequest<TDocument>
    ISourceRequest
    IRequest<SourceRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.Self
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.Assign<TValue>(TValue, Action<ISourceRequest<TDocument>, TValue>)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.Qs(string, object)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.ErrorTrace(bool?)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.FilterPath(params string[])
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.Human(bool?)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.Pretty(bool?)
    RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>.SourceQueryString(string)
    RequestBase<SourceRequestParameters>.HttpMethod
    RequestBase<SourceRequestParameters>.RequestState
    RequestBase<SourceRequestParameters>.ContentType
    RequestBase<SourceRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<SourceRequestParameters>.RequestDefaults(SourceRequestParameters)
    RequestBase<SourceRequestParameters>.Q<TOut>(string)
    RequestBase<SourceRequestParameters>.Q(string, object)
    RequestBase<SourceRequestParameters>.SetAcceptHeader(string)
    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 SourceDescriptor<TDocument> : RequestDescriptorBase<SourceDescriptor<TDocument>, SourceRequestParameters, ISourceRequest<TDocument>>, IDescriptor, ISourceRequest<TDocument>, ISourceRequest, IRequest<SourceRequestParameters>, IRequest where TDocument : class
    Type Parameters
    Name Description
    TDocument

    Constructors

    | Edit this page View Source

    SourceDescriptor()

    Used for serialization purposes, making sure we have a parameterless constructor

    Declaration
    protected SourceDescriptor()
    | Edit this page View Source

    SourceDescriptor(Id)

    /{index}/_source/{id}

    Declaration
    public SourceDescriptor(Id id)
    Parameters
    Type Name Description
    Id id

    this parameter is required

    | Edit this page View Source

    SourceDescriptor(IndexName, Id)

    /{index}/_source/{id}

    Declaration
    public SourceDescriptor(IndexName index, Id id)
    Parameters
    Type Name Description
    IndexName index

    this parameter is required

    Id id

    this parameter is required

    | Edit this page View Source

    SourceDescriptor(TDocument, IndexName, Id)

    /{index}/_source/{id}

    Declaration
    public SourceDescriptor(TDocument documentWithId, IndexName index = null, Id id = null)
    Parameters
    Type Name Description
    TDocument documentWithId
    IndexName index
    Id id

    The document used to resolve the path from

    Methods

    | Edit this page View Source

    ExecuteOnLocalShard()

    Declaration
    public SourceDescriptor<TDocument> ExecuteOnLocalShard()
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    Index(IndexName)

    The name of the index containing the document.

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

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

    Declaration
    public SourceDescriptor<TDocument> Index<TOther>() where TOther : class
    Returns
    Type Description
    SourceDescriptor<TDocument>
    Type Parameters
    Name Description
    TOther
    | Edit this page View Source

    Preference(string)

    Specifies the node or shard the operation should be performed on. Random by default.

    Declaration
    public SourceDescriptor<TDocument> Preference(string preference)
    Parameters
    Type Name Description
    string preference
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    Realtime(bool?)

    Boolean) If true, the request is real time as opposed to near real time.

    Declaration
    public SourceDescriptor<TDocument> Realtime(bool? realtime = true)
    Parameters
    Type Name Description
    bool? realtime
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    Refresh(Refresh?)

    If true, OpenSearch refreshes the affected shards to make this operation visible to search. If false, do nothing with refreshes.

    Declaration
    public SourceDescriptor<TDocument> Refresh(Refresh? refresh)
    Parameters
    Type Name Description
    Refresh? refresh
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    Routing(Routing)

    A document is routed to a particular shard in an index using the following formula

    shard_num = hash(_routing) % num_primary_shards

    OpenSearch will use the document id if not provided.

    For requests that are constructed from/for a document OpenSearch.Client will automatically infer the routing key if that document has a JoinField or a routing mapping on for its type exists on ConnectionSettings

    Declaration
    public SourceDescriptor<TDocument> Routing(Routing routing)
    Parameters
    Type Name Description
    Routing routing
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    SourceEnabled(bool?)

    Whether the _source should be included in the response.

    Declaration
    public SourceDescriptor<TDocument> SourceEnabled(bool? sourceenabled = true)
    Parameters
    Type Name Description
    bool? sourceenabled
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    SourceExcludes(Fields)

    A comma-separated list of source fields to exclude in the response.

    Declaration
    public SourceDescriptor<TDocument> SourceExcludes(Fields sourceexcludes)
    Parameters
    Type Name Description
    Fields sourceexcludes
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    SourceExcludes(params Expression<Func<TDocument, object>>[])

    A comma-separated list of source fields to exclude in the response.

    Declaration
    public SourceDescriptor<TDocument> SourceExcludes(params Expression<Func<TDocument, object>>[] fields)
    Parameters
    Type Name Description
    Expression<Func<TDocument, object>>[] fields
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    SourceIncludes(Fields)

    A comma-separated list of source fields to include in the response.

    Declaration
    public SourceDescriptor<TDocument> SourceIncludes(Fields sourceincludes)
    Parameters
    Type Name Description
    Fields sourceincludes
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    SourceIncludes(params Expression<Func<TDocument, object>>[])

    A comma-separated list of source fields to include in the response.

    Declaration
    public SourceDescriptor<TDocument> SourceIncludes(params Expression<Func<TDocument, object>>[] fields)
    Parameters
    Type Name Description
    Expression<Func<TDocument, object>>[] fields
    Returns
    Type Description
    SourceDescriptor<TDocument>
    | Edit this page View Source

    Version(long?)

    Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.

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

    VersionType(VersionType?)

    The specific version type. One of internal, external, external_gte.

    Declaration
    public SourceDescriptor<TDocument> VersionType(VersionType? versiontype)
    Parameters
    Type Name Description
    VersionType? versiontype
    Returns
    Type Description
    SourceDescriptor<TDocument>

    Implements

    IDescriptor
    ISourceRequest<TDocument>
    ISourceRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • SourceDescriptor()
      • SourceDescriptor(Id)
      • SourceDescriptor(IndexName, Id)
      • SourceDescriptor(TDocument, IndexName, Id)
    • Methods
      • ExecuteOnLocalShard()
      • Index(IndexName)
      • Index<TOther>()
      • Preference(string)
      • Realtime(bool?)
      • Refresh(Refresh?)
      • Routing(Routing)
      • SourceEnabled(bool?)
      • SourceExcludes(Fields)
      • SourceExcludes(params Expression<Func<TDocument, object>>[])
      • SourceIncludes(Fields)
      • SourceIncludes(params Expression<Func<TDocument, object>>[])
      • Version(long?)
      • VersionType(VersionType?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX