Search Results for

    Show / Hide Table of Contents

    Class IndexRequestParameters

    Request options for Index

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

    Inheritance
    object
    RequestParameters<IndexRequestParameters>
    IndexRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<IndexRequestParameters>.CustomResponseBuilder
    RequestParameters<IndexRequestParameters>.QueryString
    RequestParameters<IndexRequestParameters>.RequestConfiguration
    RequestParameters<IndexRequestParameters>.ContainsQueryString(string)
    RequestParameters<IndexRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<IndexRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<IndexRequestParameters>.SetQueryString(string, object)
    RequestParameters<IndexRequestParameters>.Q<TOut>(string)
    RequestParameters<IndexRequestParameters>.Q(string, object)
    RequestParameters<IndexRequestParameters>.SetAcceptHeader(string)
    RequestParameters<IndexRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net
    Assembly: OpenSearch.Net.dll
    Syntax
    public class IndexRequestParameters : RequestParameters<IndexRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    DefaultHttpMethod

    Declaration
    public override HttpMethod DefaultHttpMethod { get; }
    Property Value
    Type Description
    HttpMethod
    Overrides
    RequestParameters<IndexRequestParameters>.DefaultHttpMethod
    | Edit this page View Source

    IfPrimaryTerm

    Only perform the operation if the document has this primary term.

    Declaration
    public long? IfPrimaryTerm { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    IfSequenceNumber

    Only perform the operation if the document has this sequence number.

    Declaration
    public long? IfSequenceNumber { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    OpType

    Set to create to only index the document if it does not already exist (put if absent). If a document with the specified _id already exists, the indexing operation will fail. Same as using the <index>/_create endpoint. Valid values: index, create. If document id is specified, it defaults to index. Otherwise, it defaults to create.

    Declaration
    public OpType? OpType { get; set; }
    Property Value
    Type Description
    OpType?
    | Edit this page View Source

    Pipeline

    ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to _none disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.

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

    Refresh

    If true, OpenSearch refreshes the affected shards to make this operation visible to search, if wait_for then wait for a refresh to make this operation visible to search, if false do nothing with refreshes. Valid values: true, false, wait_for.

    Declaration
    public Refresh? Refresh { get; set; }
    Property Value
    Type Description
    Refresh?
    | Edit this page View Source

    RequireAlias

    If true, the destination must be an index alias.

    Declaration
    public bool? RequireAlias { get; set; }
    Property Value
    Type Description
    bool?
    | Edit this page View Source

    Routing

    Custom value used to route operations to a specific shard.

    Declaration
    public string[] Routing { get; set; }
    Property Value
    Type Description
    string[]
    | Edit this page View Source

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<IndexRequestParameters>.SupportsBody
    | Edit this page View Source

    Timeout

    Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.

    Declaration
    public TimeSpan Timeout { get; set; }
    Property Value
    Type Description
    TimeSpan
    | Edit this page View Source

    Version

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

    Declaration
    public long? Version { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    VersionType

    Specific version type: external, external_gte.

    Declaration
    public VersionType? VersionType { get; set; }
    Property Value
    Type Description
    VersionType?
    | Edit this page View Source

    WaitForActiveShards

    The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

    Declaration
    public string WaitForActiveShards { get; set; }
    Property Value
    Type Description
    string

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • DefaultHttpMethod
      • IfPrimaryTerm
      • IfSequenceNumber
      • OpType
      • Pipeline
      • Refresh
      • RequireAlias
      • Routing
      • SupportsBody
      • Timeout
      • Version
      • VersionType
      • WaitForActiveShards
    • Implements
    • Extension Methods
    Back to top Generated by DocFX