Class CreatePitRequest

Request for CreatePit

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

Inheritance
object
RequestBase<CreatePitRequestParameters>
PlainRequestBase<CreatePitRequestParameters>
CreatePitRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CreatePitRequest : PlainRequestBase<CreatePitRequestParameters>, ICreatePitRequest, IRequest<CreatePitRequestParameters>, IRequest

Constructors

| Edit this page View Source

CreatePitRequest()

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

Declaration
protected CreatePitRequest()
| Edit this page View Source

CreatePitRequest(Indices)

/{index}/_search/point_in_time

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

this parameter is required

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

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 Time KeepAlive { get; set; }
Property Value
Type Description
Time
| 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 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 Routing Routing { get; set; }
Property Value
Type Description
Routing
| Edit this page View Source

Self

Declaration
protected ICreatePitRequest Self { get; }
Property Value
Type Description
ICreatePitRequest

Implements

Extension Methods