Search Results for

    Show / Hide Table of Contents

    Class CreatePitRequestParameters

    Request options for CreatePit

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

    Inheritance
    object
    RequestParameters<CreatePitRequestParameters>
    CreatePitRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<CreatePitRequestParameters>.CustomResponseBuilder
    RequestParameters<CreatePitRequestParameters>.QueryString
    RequestParameters<CreatePitRequestParameters>.RequestConfiguration
    RequestParameters<CreatePitRequestParameters>.ContainsQueryString(string)
    RequestParameters<CreatePitRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<CreatePitRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<CreatePitRequestParameters>.SetQueryString(string, object)
    RequestParameters<CreatePitRequestParameters>.Q<TOut>(string)
    RequestParameters<CreatePitRequestParameters>.Q(string, object)
    RequestParameters<CreatePitRequestParameters>.SetAcceptHeader(string)
    RequestParameters<CreatePitRequestParameters>.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 CreatePitRequestParameters : RequestParameters<CreatePitRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    AllowPartialPitCreation

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

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

    DefaultHttpMethod

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

    ExpandWildcards

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

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

    KeepAlive

    Specify the keep alive for point in time.

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

    Preference

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

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

    Routing

    Comma-separated list of specific routing values.

    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<CreatePitRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AllowPartialPitCreation
      • DefaultHttpMethod
      • ExpandWildcards
      • KeepAlive
      • Preference
      • Routing
      • SupportsBody
    • Implements
    • Extension Methods
    Back to top Generated by DocFX