Class ViewQueryRequest

Inheritance

object

ViewQueryRequest

Implements

IMessage<ViewQueryRequest>

IEquatable<ViewQueryRequest>

IDeepCloneable<ViewQueryRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Couchbase.Protostellar.View.V1

Assembly: Couchbase.NetClient.dll

Syntax

public sealed class ViewQueryRequest : IMessage<ViewQueryRequest>, IEquatable<ViewQueryRequest>, IDeepCloneable<ViewQueryRequest>, IBufferMessage, IMessage

Constructors

ViewQueryRequest()

Declaration

public ViewQueryRequest()

ViewQueryRequest(ViewQueryRequest)

Declaration

public ViewQueryRequest(ViewQueryRequest other)

Parameters

Type	Name	Description
ViewQueryRequest	other

Fields

BucketNameFieldNumber

Field number for the "bucket_name" field.

Declaration

public const int BucketNameFieldNumber = 8

Field Value

Type	Description
int

DebugFieldNumber

Field number for the "debug" field.

Declaration

public const int DebugFieldNumber = 18

Field Value

Type	Description
int

DesignDocumentNameFieldNumber

Field number for the "design_document_name" field.

Declaration

public const int DesignDocumentNameFieldNumber = 1

Field Value

Type	Description
int

EndKeyDocIdFieldNumber

Field number for the "end_key_doc_id" field.

Declaration

public const int EndKeyDocIdFieldNumber = 16

Field Value

Type	Description
int

EndKeyFieldNumber

Field number for the "end_key" field.

Declaration

public const int EndKeyFieldNumber = 13

Field Value

Type	Description
int

GroupFieldNumber

Field number for the "group" field.

Declaration

public const int GroupFieldNumber = 7

Field Value

Type	Description
int

GroupLevelFieldNumber

Field number for the "group_level" field.

Declaration

public const int GroupLevelFieldNumber = 9

Field Value

Type	Description
int

InclusiveEndFieldNumber

Field number for the "inclusive_end" field.

Declaration

public const int InclusiveEndFieldNumber = 14

Field Value

Type	Description
int

KeyFieldNumber

Field number for the "key" field.

Declaration

public const int KeyFieldNumber = 10

Field Value

Type	Description
int

KeysFieldNumber

Field number for the "keys" field.

Declaration

public const int KeysFieldNumber = 11

Field Value

Type	Description
int

LimitFieldNumber

Field number for the "limit" field.

Declaration

public const int LimitFieldNumber = 4

Field Value

Type	Description
int

NamespaceFieldNumber

Field number for the "namespace" field.

Declaration

public const int NamespaceFieldNumber = 19

Field Value

Type	Description
int

OnErrorFieldNumber

Field number for the "on_error" field.

Declaration

public const int OnErrorFieldNumber = 17

Field Value

Type	Description
int

OrderFieldNumber

Field number for the "order" field.

Declaration

public const int OrderFieldNumber = 20

Field Value

Type	Description
int

ReduceFieldNumber

Field number for the "reduce" field.

Declaration

public const int ReduceFieldNumber = 6

Field Value

Type	Description
int

ScanConsistencyFieldNumber

Field number for the "scan_consistency" field.

Declaration

public const int ScanConsistencyFieldNumber = 5

Field Value

Type	Description
int

SkipFieldNumber

Field number for the "skip" field.

Declaration

public const int SkipFieldNumber = 3

Field Value

Type	Description
int

StartKeyDocIdFieldNumber

Field number for the "start_key_doc_id" field.

Declaration

public const int StartKeyDocIdFieldNumber = 15

Field Value

Type	Description
int

StartKeyFieldNumber

Field number for the "start_key" field.

Declaration

public const int StartKeyFieldNumber = 12

Field Value

Type	Description
int

ViewNameFieldNumber

Field number for the "view_name" field.

Declaration

public const int ViewNameFieldNumber = 2

Field Value

Type	Description
int

Properties

BucketName

Declaration

public string BucketName { get; set; }

Property Value

Type	Description
string

Debug

Declaration

public bool Debug { get; set; }

Property Value

Type	Description
bool

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

DesignDocumentName

Declaration

public string DesignDocumentName { get; set; }

Property Value

Type	Description
string

EndKey

Declaration

public ByteString EndKey { get; set; }

Property Value

Type	Description
ByteString

EndKeyDocId

Declaration

public string EndKeyDocId { get; set; }

Property Value

Type	Description
string

Group

Declaration

public bool Group { get; set; }

Property Value

Type	Description
bool

GroupLevel

Declaration

public uint GroupLevel { get; set; }

Property Value

Type	Description
uint

HasDebug

Gets whether the "debug" field is set

Declaration

public bool HasDebug { get; }

Property Value

Type	Description
bool

HasEndKey

Gets whether the "end_key" field is set

Declaration

public bool HasEndKey { get; }

Property Value

Type	Description
bool

HasEndKeyDocId

Gets whether the "end_key_doc_id" field is set

Declaration

public bool HasEndKeyDocId { get; }

Property Value

Type	Description
bool

HasGroup

Gets whether the "group" field is set

Declaration

public bool HasGroup { get; }

Property Value

Type	Description
bool

HasGroupLevel

Gets whether the "group_level" field is set

Declaration

public bool HasGroupLevel { get; }

Property Value

Type	Description
bool

HasInclusiveEnd

Gets whether the "inclusive_end" field is set

Declaration

public bool HasInclusiveEnd { get; }

Property Value

Type	Description
bool

HasKey

Gets whether the "key" field is set

Declaration

public bool HasKey { get; }

Property Value

Type	Description
bool

HasLimit

Gets whether the "limit" field is set

Declaration

public bool HasLimit { get; }

Property Value

Type	Description
bool

HasNamespace

Gets whether the "namespace" field is set

Declaration

public bool HasNamespace { get; }

Property Value

Type	Description
bool

HasOnError

Gets whether the "on_error" field is set

Declaration

public bool HasOnError { get; }

Property Value

Type	Description
bool

HasOrder

Gets whether the "order" field is set

Declaration

public bool HasOrder { get; }

Property Value

Type	Description
bool

HasReduce

Gets whether the "reduce" field is set

Declaration

public bool HasReduce { get; }

Property Value

Type	Description
bool

HasScanConsistency

Gets whether the "scan_consistency" field is set

Declaration

public bool HasScanConsistency { get; }

Property Value

Type	Description
bool

HasSkip

Gets whether the "skip" field is set

Declaration

public bool HasSkip { get; }

Property Value

Type	Description
bool

HasStartKey

Gets whether the "start_key" field is set

Declaration

public bool HasStartKey { get; }

Property Value

Type	Description
bool

HasStartKeyDocId

Gets whether the "start_key_doc_id" field is set

Declaration

public bool HasStartKeyDocId { get; }

Property Value

Type	Description
bool

InclusiveEnd

Declaration

public bool InclusiveEnd { get; set; }

Property Value

Type	Description
bool

Key

Declaration

public ByteString Key { get; set; }

Property Value

Type	Description
ByteString

Keys

Declaration

public RepeatedField<ByteString> Keys { get; }

Property Value

Type	Description
RepeatedField<ByteString>

Limit

Declaration

public uint Limit { get; set; }

Property Value

Type	Description
uint

Namespace

Declaration

public ViewQueryRequest.Types.Namespace Namespace { get; set; }

Property Value

Type	Description
ViewQueryRequest.Types.Namespace

OnError

Declaration

public ViewQueryRequest.Types.ErrorMode OnError { get; set; }

Property Value

Type	Description
ViewQueryRequest.Types.ErrorMode

Order

Declaration

public ViewQueryRequest.Types.Order Order { get; set; }

Property Value

Type	Description
ViewQueryRequest.Types.Order

Parser

Declaration

public static MessageParser<ViewQueryRequest> Parser { get; }

Property Value

Type	Description
MessageParser<ViewQueryRequest>

Reduce

Declaration

public bool Reduce { get; set; }

Property Value

Type	Description
bool

ScanConsistency

Declaration

public ViewQueryRequest.Types.ScanConsistency ScanConsistency { get; set; }

Property Value

Type	Description
ViewQueryRequest.Types.ScanConsistency

Skip

Declaration

public uint Skip { get; set; }

Property Value

Type	Description
uint

StartKey

Declaration

public ByteString StartKey { get; set; }

Property Value

Type	Description
ByteString

StartKeyDocId

Declaration

public string StartKeyDocId { get; set; }

Property Value

Type	Description
string

ViewName

Declaration

public string ViewName { get; set; }

Property Value

Type	Description
string

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Declaration

public int CalculateSize()

Returns

Type	Description
int	The number of bytes required to write this message to a coded output stream.

ClearDebug()

Clears the value of the "debug" field

Declaration

public void ClearDebug()

ClearEndKey()

Clears the value of the "end_key" field

Declaration

public void ClearEndKey()

ClearEndKeyDocId()

Clears the value of the "end_key_doc_id" field

Declaration

public void ClearEndKeyDocId()

ClearGroup()

Clears the value of the "group" field

Declaration

public void ClearGroup()

ClearGroupLevel()

Clears the value of the "group_level" field

Declaration

public void ClearGroupLevel()

ClearInclusiveEnd()

Clears the value of the "inclusive_end" field

Declaration

public void ClearInclusiveEnd()

ClearKey()

Clears the value of the "key" field

Declaration

public void ClearKey()

ClearLimit()

Clears the value of the "limit" field

Declaration

public void ClearLimit()

ClearNamespace()

Clears the value of the "namespace" field

Declaration

public void ClearNamespace()

ClearOnError()

Clears the value of the "on_error" field

Declaration

public void ClearOnError()

ClearOrder()

Clears the value of the "order" field

Declaration

public void ClearOrder()

ClearReduce()

Clears the value of the "reduce" field

Declaration

public void ClearReduce()

ClearScanConsistency()

Clears the value of the "scan_consistency" field

Declaration

public void ClearScanConsistency()

ClearSkip()

Clears the value of the "skip" field

Declaration

public void ClearSkip()

ClearStartKey()

Clears the value of the "start_key" field

Declaration

public void ClearStartKey()

ClearStartKeyDocId()

Clears the value of the "start_key_doc_id" field

Declaration

public void ClearStartKeyDocId()

Clone()

Creates a deep clone of this object.

Declaration

public ViewQueryRequest Clone()

Returns

Type	Description
ViewQueryRequest	A deep clone of this object.

Equals(ViewQueryRequest)

Declaration

public bool Equals(ViewQueryRequest other)

Parameters

Type	Name	Description
ViewQueryRequest	other

Returns

Type	Description
bool

Equals(object)

Declaration

public override bool Equals(object other)

Parameters

Type	Name	Description
object	other

Returns

Type	Description
bool

Overrides

object.Equals(object)

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Overrides

object.GetHashCode()

MergeFrom(ViewQueryRequest)

Merges the given message into this one.

Declaration

public void MergeFrom(ViewQueryRequest other)

Parameters

Type	Name	Description
ViewQueryRequest	other

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

Declaration

public void MergeFrom(CodedInputStream input)

Parameters

Type	Name	Description
CodedInputStream	input

Remarks

See the user guide for precise merge semantics.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

Declaration

public void WriteTo(CodedOutputStream output)

Parameters

Type	Name	Description
CodedOutputStream	output	Coded output stream to write the data to. Must not be null.

Implements

Google.Protobuf.IMessage<T>

IEquatable<T>

Google.Protobuf.IDeepCloneable<T>

Google.Protobuf.IBufferMessage

Google.Protobuf.IMessage