Class CreatePitRequestParameters

Request options for CreatePit

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#create-a-pit</p>
Inheritance
object
RequestParameters<CreatePitRequestParameters>
CreatePitRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net
Assembly: OpenSearch.Net.dll
Syntax
public class CreatePitRequestParameters : RequestParameters<CreatePitRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

AllowNoIndices

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.

Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| 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
| 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

IgnoreThrottled

If true, concrete, expanded or aliased indexes will be ignored when frozen.

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

IgnoreUnavailable

If false, the request returns an error if it targets a missing or closed index.

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| 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

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| 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

A 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

Implements

Extension Methods