Class SourceExistsDescriptor<TDocument>
Descriptor for SourceExists
https://opensearch.org/docs/latest/api-reference/document-apis/get-documents/
Inheritance
SourceExistsDescriptor<TDocument>
Assembly: OpenSearch.Client.dll
Syntax
public class SourceExistsDescriptor<TDocument> : RequestDescriptorBase<SourceExistsDescriptor<TDocument>, SourceExistsRequestParameters, ISourceExistsRequest<TDocument>>, IDescriptor, ISourceExistsRequest<TDocument>, ISourceExistsRequest, IRequest<SourceExistsRequestParameters>, IRequest where TDocument : class
Type Parameters
| Name |
Description |
| TDocument |
|
Constructors
|
Edit this page
View Source
SourceExistsDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected SourceExistsDescriptor()
|
Edit this page
View Source
SourceExistsDescriptor(Id)
Declaration
public SourceExistsDescriptor(Id id)
Parameters
| Type |
Name |
Description |
| Id |
id |
this parameter is required
|
|
Edit this page
View Source
SourceExistsDescriptor(IndexName, Id)
Declaration
public SourceExistsDescriptor(IndexName index, Id id)
Parameters
| Type |
Name |
Description |
| IndexName |
index |
this parameter is required
|
| Id |
id |
this parameter is required
|
|
Edit this page
View Source
SourceExistsDescriptor(TDocument, IndexName, Id)
Declaration
public SourceExistsDescriptor(TDocument documentWithId, IndexName index = null, Id id = null)
Parameters
| Type |
Name |
Description |
| TDocument |
documentWithId |
|
| IndexName |
index |
|
| Id |
id |
The document used to resolve the path from
|
Methods
|
Edit this page
View Source
Index(IndexName)
Comma-separated list of data streams, indexes, and aliases. Supports wildcards (*).
Declaration
public SourceExistsDescriptor<TDocument> Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public SourceExistsDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Preference(string)
Specifies the node or shard the operation should be performed on. Random by default.
Declaration
public SourceExistsDescriptor<TDocument> Preference(string preference)
Parameters
| Type |
Name |
Description |
| string |
preference |
|
Returns
|
Edit this page
View Source
Realtime(bool?)
If true, the request is real-time as opposed to near-real-time.
Declaration
public SourceExistsDescriptor<TDocument> Realtime(bool? realtime = true)
Parameters
| Type |
Name |
Description |
| bool? |
realtime |
|
Returns
|
Edit this page
View Source
Refresh(Refresh?)
If true, OpenSearch refreshes all shards involved in the delete by query after the request completes.
Declaration
public SourceExistsDescriptor<TDocument> Refresh(Refresh? refresh)
Parameters
| Type |
Name |
Description |
| Refresh? |
refresh |
|
Returns
|
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 SourceExistsDescriptor<TDocument> Routing(Routing routing)
Parameters
| Type |
Name |
Description |
| Routing |
routing |
|
Returns
|
Edit this page
View Source
SourceEnabled(bool?)
Whether the _source should be included in the response.
Declaration
public SourceExistsDescriptor<TDocument> SourceEnabled(bool? sourceenabled = true)
Parameters
| Type |
Name |
Description |
| bool? |
sourceenabled |
|
Returns
|
Edit this page
View Source
SourceExcludes(Fields)
A comma-separated list of source fields to exclude in the response.
Declaration
public SourceExistsDescriptor<TDocument> SourceExcludes(Fields sourceexcludes)
Parameters
| Type |
Name |
Description |
| Fields |
sourceexcludes |
|
Returns
|
Edit this page
View Source
SourceExcludes(params Expression<Func<TDocument, object>>[])
A comma-separated list of source fields to exclude in the response.
Declaration
public SourceExistsDescriptor<TDocument> SourceExcludes(params Expression<Func<TDocument, object>>[] fields)
Parameters
Returns
|
Edit this page
View Source
SourceIncludes(Fields)
A comma-separated list of source fields to include in the response.
Declaration
public SourceExistsDescriptor<TDocument> SourceIncludes(Fields sourceincludes)
Parameters
| Type |
Name |
Description |
| Fields |
sourceincludes |
|
Returns
|
Edit this page
View Source
SourceIncludes(params Expression<Func<TDocument, object>>[])
A comma-separated list of source fields to include in the response.
Declaration
public SourceExistsDescriptor<TDocument> SourceIncludes(params Expression<Func<TDocument, object>>[] fields)
Parameters
Returns
|
Edit this page
View Source
Version(long?)
Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.
Declaration
public SourceExistsDescriptor<TDocument> Version(long? version)
Parameters
| Type |
Name |
Description |
| long? |
version |
|
Returns
|
Edit this page
View Source
VersionType(VersionType?)
Specific version type: external, external_gte.
Declaration
public SourceExistsDescriptor<TDocument> VersionType(VersionType? versiontype)
Parameters
Returns
Implements
Extension Methods