Class GetDescriptor<TDocument>
Descriptor for Get
https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
Inheritance
GetDescriptor<TDocument>
Assembly: OpenSearch.Client.dll
Syntax
public class GetDescriptor<TDocument> : RequestDescriptorBase<GetDescriptor<TDocument>, GetRequestParameters, IGetRequest<TDocument>>, IDescriptor, IGetRequest<TDocument>, IGetRequest, IRequest<GetRequestParameters>, IRequest where TDocument : class
Type Parameters
Name |
Description |
TDocument |
|
Constructors
|
Edit this page
View Source
GetDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected GetDescriptor()
|
Edit this page
View Source
GetDescriptor(Id)
Declaration
public GetDescriptor(Id id)
Parameters
Type |
Name |
Description |
Id |
id |
this parameter is required
|
|
Edit this page
View Source
GetDescriptor(IndexName, Id)
Declaration
public GetDescriptor(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
GetDescriptor(TDocument, IndexName, Id)
Declaration
public GetDescriptor(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
ExecuteOnLocalShard()
Declaration
public GetDescriptor<TDocument> ExecuteOnLocalShard()
Returns
|
Edit this page
View Source
Index(IndexName)
Declaration
public GetDescriptor<TDocument> Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public GetDescriptor<TDocument> Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Preference(string)
Specify the node or shard the operation should be performed on (default: random)
Declaration
public GetDescriptor<TDocument> Preference(string preference)
Parameters
Type |
Name |
Description |
string |
preference |
|
Returns
|
Edit this page
View Source
Realtime(bool?)
Specify whether to perform the operation in realtime or search mode
Declaration
public GetDescriptor<TDocument> Realtime(bool? realtime = true)
Parameters
Type |
Name |
Description |
bool? |
realtime |
|
Returns
|
Edit this page
View Source
Refresh(bool?)
Refresh the shard containing the document before performing the operation
Declaration
public GetDescriptor<TDocument> Refresh(bool? refresh = true)
Parameters
Type |
Name |
Description |
bool? |
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 OSC 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 GetDescriptor<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 GetDescriptor<TDocument> SourceEnabled(bool? sourceenabled = true)
Parameters
Type |
Name |
Description |
bool? |
sourceenabled |
|
Returns
|
Edit this page
View Source
SourceExcludes(Fields)
A list of fields to exclude from the returned _source field
Declaration
public GetDescriptor<TDocument> SourceExcludes(Fields sourceexcludes)
Parameters
Type |
Name |
Description |
Fields |
sourceexcludes |
|
Returns
|
Edit this page
View Source
SourceExcludes(params Expression<Func<TDocument, object>>[])
A list of fields to exclude from the returned _source field
Declaration
public GetDescriptor<TDocument> SourceExcludes(params Expression<Func<TDocument, object>>[] fields)
Parameters
Returns
|
Edit this page
View Source
SourceIncludes(Fields)
A list of fields to extract and return from the _source field
Declaration
public GetDescriptor<TDocument> SourceIncludes(Fields sourceincludes)
Parameters
Type |
Name |
Description |
Fields |
sourceincludes |
|
Returns
|
Edit this page
View Source
SourceIncludes(params Expression<Func<TDocument, object>>[])
A list of fields to extract and return from the _source field
Declaration
public GetDescriptor<TDocument> SourceIncludes(params Expression<Func<TDocument, object>>[] fields)
Parameters
Returns
|
Edit this page
View Source
StoredFields(Fields)
A comma-separated list of stored fields to return in the response
Declaration
public GetDescriptor<TDocument> StoredFields(Fields storedfields)
Parameters
Type |
Name |
Description |
Fields |
storedfields |
|
Returns
|
Edit this page
View Source
StoredFields(params Expression<Func<TDocument, object>>[])
A comma-separated list of stored fields to return in the response
Declaration
public GetDescriptor<TDocument> StoredFields(params Expression<Func<TDocument, object>>[] fields)
Parameters
Returns
|
Edit this page
View Source
Version(long?)
Explicit version number for concurrency control
Declaration
public GetDescriptor<TDocument> Version(long? version)
Parameters
Type |
Name |
Description |
long? |
version |
|
Returns
|
Edit this page
View Source
VersionType(VersionType?)
Declaration
public GetDescriptor<TDocument> VersionType(VersionType? versiontype)
Parameters
Returns
Implements
Extension Methods