Class CreatePitDescriptor

Descriptor for CreatePit

<p>https://docs.opensearch.org/latest/api-reference/search-apis/point-in-time-api/#create-a-pit</p>
Inheritance
object
RequestBase<CreatePitRequestParameters>
RequestDescriptorBase<CreatePitDescriptor, CreatePitRequestParameters, ICreatePitRequest>
CreatePitDescriptor
Implements
Inherited Members
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

AllowNoIndices(bool?)

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 CreatePitDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
Type Name Description
bool? allownoindices
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

IgnoreThrottled(bool?)

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

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

IgnoreUnavailable(bool?)

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

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

Index(Indices)

A comma-separated list of indexes; use _all or empty string 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

Extension Methods