Search Results for

    Show / Hide Table of Contents

    Class CreatePitDescriptor

    Descriptor for CreatePit

    https://opensearch.org/docs/latest/search-plugins/point-in-time-api/#create-a-pit

    Inheritance
    object
    RequestBase<CreatePitRequestParameters>
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>
    CreatePitDescriptor
    Implements
    IDescriptor
    ICreatePitRequest
    IRequest<CreatePitRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.Self
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.Assign<TValue>(TValue, Action<ICreatePitRequest, TValue>)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.Qs(string, object)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.FilterPath(params string[])
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.Human(bool?)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.Pretty(bool?)
    RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>.SourceQueryString(string)
    RequestBase<CreatePitRequestParameters>.HttpMethod
    RequestBase<CreatePitRequestParameters>.RequestState
    RequestBase<CreatePitRequestParameters>.ContentType
    RequestBase<CreatePitRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<CreatePitRequestParameters>.RequestDefaults(CreatePitRequestParameters)
    RequestBase<CreatePitRequestParameters>.Q<TOut>(string)
    RequestBase<CreatePitRequestParameters>.Q(string, object)
    RequestBase<CreatePitRequestParameters>.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 CreatePitDescriptor : RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>, IDescriptor, ICreatePitRequest, IRequest<CreatePitRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    CreatePitDescriptor()

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

    Declaration
    protected CreatePitDescriptor()
    | Edit this page View Source

    CreatePitDescriptor(Indices)

    /{index}/_search/point_in_time

    Declaration
    public CreatePitDescriptor(Indices index)
    Parameters
    Type Name Description
    Indices index

    this parameter is required

    Methods

    | Edit this page View Source

    AllIndices()

    A shortcut into calling Index(Indices.All)

    Declaration
    public CreatePitDescriptor AllIndices()
    Returns
    Type Description
    CreatePitDescriptor
    | Edit this page View Source

    AllowPartialPitCreation(bool?)

    Allow if point in time can be created with partial failures.

    Declaration
    public CreatePitDescriptor AllowPartialPitCreation(bool? allowpartialpitcreation = true)
    Parameters
    Type Name Description
    bool? allowpartialpitcreation
    Returns
    Type Description
    CreatePitDescriptor
    | Edit this page View Source

    ExpandWildcards(ExpandWildcards?)

    Whether to expand wildcard expression to concrete indexes that are open, closed or both.

    Declaration
    public CreatePitDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
    Parameters
    Type Name Description
    ExpandWildcards? expandwildcards
    Returns
    Type Description
    CreatePitDescriptor
    | Edit this page View Source

    Index(Indices)

    Comma-separated list of indexes; use the special string _all or Indices.All to perform the operation on all indexes.

    Declaration
    public CreatePitDescriptor Index(Indices index)
    Parameters
    Type Name Description
    Indices index
    Returns
    Type Description
    CreatePitDescriptor
    | Edit this page View Source

    Index<TOther>()

    a shortcut into calling Index(typeof(TOther))

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

    KeepAlive(Time)

    Specify the keep alive for point in time.

    Declaration
    public CreatePitDescriptor KeepAlive(Time keepalive)
    Parameters
    Type Name Description
    Time keepalive
    Returns
    Type Description
    CreatePitDescriptor
    | Edit this page View Source

    Preference(string)

    Specify the node or shard the operation should be performed on.

    Declaration
    public CreatePitDescriptor Preference(string preference)
    Parameters
    Type Name Description
    string preference
    Returns
    Type Description
    CreatePitDescriptor
    | 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 CreatePitDescriptor Routing(Routing routing)
    Parameters
    Type Name Description
    Routing routing
    Returns
    Type Description
    CreatePitDescriptor

    Implements

    IDescriptor
    ICreatePitRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CreatePitDescriptor()
      • CreatePitDescriptor(Indices)
    • Methods
      • AllIndices()
      • AllowPartialPitCreation(bool?)
      • ExpandWildcards(ExpandWildcards?)
      • Index(Indices)
      • Index<TOther>()
      • KeepAlive(Time)
      • Preference(string)
      • Routing(Routing)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX