C# OJAI Client API
Com.Mapr.Data.Db.FindByIdRequest Class Reference
Inheritance diagram for Com.Mapr.Data.Db.FindByIdRequest:

Public Types

enum  ConditionOneofCase { None = 0, JsonCondition = 4 }
 Enum of possible cases for the "condition" oneof. More...
 
enum  DocumentOneofCase { None = 0, JsonDocument = 5 }
 Enum of possible cases for the "document" oneof. More...
 

Public Member Functions

 FindByIdRequest (FindByIdRequest other)
 
FindByIdRequest Clone ()
 
void ClearCondition ()
 
void ClearDocument ()
 
override bool Equals (object other)
 
bool Equals (FindByIdRequest other)
 
override int GetHashCode ()
 
override string ToString ()
 
void WriteTo (pb::CodedOutputStream output)
 
int CalculateSize ()
 
void MergeFrom (FindByIdRequest other)
 
void MergeFrom (pb::CodedInputStream input)
 

Public Attributes

const int TablePathFieldNumber = 1
 Field number for the "table_path" field. More...
 
const int PayloadEncodingFieldNumber = 2
 Field number for the "payload_encoding" field. More...
 
const int ProjectionsFieldNumber = 3
 Field number for the "projections" field. More...
 
const int JsonConditionFieldNumber = 4
 Field number for the "json_condition" field. More...
 
const int JsonDocumentFieldNumber = 5
 Field number for the "json_document" field. More...
 

Properties

static pb::MessageParser< FindByIdRequestParser [get]
 
static pbr::MessageDescriptor Descriptor [get]
 
pbr::MessageDescriptor pb::IMessage. Descriptor [get]
 
string TablePath [get, set]
 
global::Com.Mapr.Data.Db.PayloadEncoding PayloadEncoding [get, set]
 
pbc::RepeatedField< string > Projections [get]
 
  • <b>[Optional]</b><p/> List of OJAI FieldPaths that should be included in the returned document
More...
 
string? JsonCondition [get, set]
 
  • <b>[Optional]</b><p/> Contains JSON encoded OJAI QueryCondition when payload_encoding is JSON_ENCODING.<p/>
More...
 
string? JsonDocument [get, set]
 
  • <b>[Required]</b><p/> Contains JSON encoded OJAI Document with _id field when payload_encoding is JSON_ENCODING.<p/>
More...
 
ConditionOneofCase ConditionCase [get]
 
DocumentOneofCase DocumentCase [get]
 

Private Member Functions

partial void OnConstruction ()
 

Private Attributes

pb::UnknownFieldSet _unknownFields
 
string tablePath_ = ""
 
global::Com.Mapr.Data.Db.PayloadEncoding payloadEncoding_ = 0
 
readonly pbc::RepeatedField< string > projections_ = new pbc::RepeatedField<string>()
 
object condition_
 
ConditionOneofCase conditionCase_ = ConditionOneofCase.None
 
object document_
 
DocumentOneofCase documentCase_ = DocumentOneofCase.None
 

Static Private Attributes

static readonly pb::MessageParser< FindByIdRequest_parser = new pb::MessageParser<FindByIdRequest>(() => new FindByIdRequest())
 
static readonly pb::FieldCodec< string > _repeated_projections_codec = pb::FieldCodec.ForString(26)
 

Member Enumeration Documentation

◆ ConditionOneofCase

Enum of possible cases for the "condition" oneof.

◆ DocumentOneofCase

Enum of possible cases for the "document" oneof.

Member Data Documentation

◆ JsonConditionFieldNumber

const int Com.Mapr.Data.Db.FindByIdRequest.JsonConditionFieldNumber = 4

Field number for the "json_condition" field.

◆ JsonDocumentFieldNumber

const int Com.Mapr.Data.Db.FindByIdRequest.JsonDocumentFieldNumber = 5

Field number for the "json_document" field.

◆ PayloadEncodingFieldNumber

const int Com.Mapr.Data.Db.FindByIdRequest.PayloadEncodingFieldNumber = 2

Field number for the "payload_encoding" field.

◆ ProjectionsFieldNumber

const int Com.Mapr.Data.Db.FindByIdRequest.ProjectionsFieldNumber = 3

Field number for the "projections" field.

◆ TablePathFieldNumber

const int Com.Mapr.Data.Db.FindByIdRequest.TablePathFieldNumber = 1

Field number for the "table_path" field.

Property Documentation

◆ JsonCondition

string? Com.Mapr.Data.Db.FindByIdRequest.JsonCondition
getset

  • <b>[Optional]</b><p/> Contains JSON encoded OJAI QueryCondition when payload_encoding is JSON_ENCODING.<p/>

◆ JsonDocument

string? Com.Mapr.Data.Db.FindByIdRequest.JsonDocument
getset

  • <b>[Required]</b><p/> Contains JSON encoded OJAI Document with _id field when payload_encoding is JSON_ENCODING.<p/>

◆ Projections

pbc.RepeatedField<string> Com.Mapr.Data.Db.FindByIdRequest.Projections
get

  • <b>[Optional]</b><p/> List of OJAI FieldPaths that should be included in the returned document