Class SearchQueryRequest

Inheritance

object

SearchQueryRequest

Implements

IMessage<SearchQueryRequest>

IEquatable<SearchQueryRequest>

IDeepCloneable<SearchQueryRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Couchbase.Protostellar.Search.V1

Assembly: Couchbase.NetClient.dll

Syntax

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

Constructors

SearchQueryRequest()

Declaration

public SearchQueryRequest()

SearchQueryRequest(SearchQueryRequest)

Declaration

public SearchQueryRequest(SearchQueryRequest other)

Parameters

Type	Name	Description
SearchQueryRequest	other

Fields

BucketNameFieldNumber

Field number for the "bucket_name" field.

Declaration

public const int BucketNameFieldNumber = 15

Field Value

Type	Description
int

CollectionsFieldNumber

Field number for the "collections" field.

Declaration

public const int CollectionsFieldNumber = 12

Field Value

Type	Description
int

DisableScoringFieldNumber

Field number for the "disable_scoring" field.

Declaration

public const int DisableScoringFieldNumber = 11

Field Value

Type	Description
int

FacetsFieldNumber

Field number for the "facets" field.

Declaration

public const int FacetsFieldNumber = 14

Field Value

Type	Description
int

FieldsFieldNumber

Field number for the "fields" field.

Declaration

public const int FieldsFieldNumber = 9

Field Value

Type	Description
int

HighlightFieldsFieldNumber

Field number for the "highlight_fields" field.

Declaration

public const int HighlightFieldsFieldNumber = 8

Field Value

Type	Description
int

HighlightStyleFieldNumber

Field number for the "highlight_style" field.

Declaration

public const int HighlightStyleFieldNumber = 7

Field Value

Type	Description
int

IncludeExplanationFieldNumber

Field number for the "include_explanation" field.

Declaration

public const int IncludeExplanationFieldNumber = 6

Field Value

Type	Description
int

IncludeLocationsFieldNumber

Field number for the "include_locations" field.

Declaration

public const int IncludeLocationsFieldNumber = 13

Field Value

Type	Description
int

IndexNameFieldNumber

Field number for the "index_name" field.

Declaration

public const int IndexNameFieldNumber = 1

Field Value

Type	Description
int

LimitFieldNumber

Field number for the "limit" field.

Declaration

public const int LimitFieldNumber = 4

Field Value

Type	Description
int

QueryFieldNumber

Field number for the "query" field.

Declaration

public const int QueryFieldNumber = 2

Field Value

Type	Description
int

ScanConsistencyFieldNumber

Field number for the "scan_consistency" field.

Declaration

public const int ScanConsistencyFieldNumber = 3

Field Value

Type	Description
int

ScopeNameFieldNumber

Field number for the "scope_name" field.

Declaration

public const int ScopeNameFieldNumber = 16

Field Value

Type	Description
int

SkipFieldNumber

Field number for the "skip" field.

Declaration

public const int SkipFieldNumber = 5

Field Value

Type	Description
int

SortFieldNumber

Field number for the "sort" field.

Declaration

public const int SortFieldNumber = 10

Field Value

Type	Description
int

Properties

BucketName

Declaration

public string BucketName { get; set; }

Property Value

Type	Description
string

Collections

Declaration

public RepeatedField<string> Collections { get; }

Property Value

Type	Description
RepeatedField<string>

Descriptor

Declaration

public static MessageDescriptor Descriptor { get; }

Property Value

Type	Description
MessageDescriptor

DisableScoring

Declaration

public bool DisableScoring { get; set; }

Property Value

Type	Description
bool

Facets

Declaration

public MapField<string, Facet> Facets { get; }

Property Value

Type	Description
MapField<string, Facet>

Fields

Declaration

public RepeatedField<string> Fields { get; }

Property Value

Type	Description
RepeatedField<string>

HasBucketName

Gets whether the "bucket_name" field is set

Declaration

public bool HasBucketName { get; }

Property Value

Type	Description
bool

HasScopeName

Gets whether the "scope_name" field is set

Declaration

public bool HasScopeName { get; }

Property Value

Type	Description
bool

HighlightFields

Declaration

public RepeatedField<string> HighlightFields { get; }

Property Value

Type	Description
RepeatedField<string>

HighlightStyle

Declaration

public SearchQueryRequest.Types.HighlightStyle HighlightStyle { get; set; }

Property Value

Type	Description
SearchQueryRequest.Types.HighlightStyle

IncludeExplanation

Declaration

public bool IncludeExplanation { get; set; }

Property Value

Type	Description
bool

IncludeLocations

Declaration

public bool IncludeLocations { get; set; }

Property Value

Type	Description
bool

IndexName

Declaration

public string IndexName { get; set; }

Property Value

Type	Description
string

Limit

Declaration

public uint Limit { get; set; }

Property Value

Type	Description
uint

Parser

Declaration

public static MessageParser<SearchQueryRequest> Parser { get; }

Property Value

Type	Description
MessageParser<SearchQueryRequest>

Query

Declaration

public Query Query { get; set; }

Property Value

Type	Description
Query

ScanConsistency

Declaration

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

Property Value

Type	Description
SearchQueryRequest.Types.ScanConsistency

ScopeName

Declaration

public string ScopeName { get; set; }

Property Value

Type	Description
string

Skip

Declaration

public uint Skip { get; set; }

Property Value

Type	Description
uint

Sort

Declaration

public RepeatedField<Sorting> Sort { get; }

Property Value

Type	Description
RepeatedField<Sorting>

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.

ClearBucketName()

Clears the value of the "bucket_name" field

Declaration

public void ClearBucketName()

ClearScopeName()

Clears the value of the "scope_name" field

Declaration

public void ClearScopeName()

Clone()

Creates a deep clone of this object.

Declaration

public SearchQueryRequest Clone()

Returns

Type	Description
SearchQueryRequest	A deep clone of this object.

Equals(SearchQueryRequest)

Declaration

public bool Equals(SearchQueryRequest other)

Parameters

Type	Name	Description
SearchQueryRequest	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(SearchQueryRequest)

Merges the given message into this one.

Declaration

public void MergeFrom(SearchQueryRequest other)

Parameters

Type	Name	Description
SearchQueryRequest	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