Documentation

ViewQueryRequest extends Message
in package

Generated from protobuf message <code>couchbase.view.v1.ViewQueryRequest</code>

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>string bucket_name = 8;</code>
$debug  : mixed
Generated from protobuf field <code>optional bool debug = 18;</code>
$design_document_name  : mixed
Generated from protobuf field <code>string design_document_name = 1;</code>
$end_key  : mixed
Generated from protobuf field <code>optional bytes end_key = 13;</code>
$end_key_doc_id  : mixed
Generated from protobuf field <code>optional string end_key_doc_id = 16;</code>
$group  : mixed
Generated from protobuf field <code>optional bool group = 7;</code>
$group_level  : mixed
Generated from protobuf field <code>optional uint32 group_level = 9;</code>
$inclusive_end  : mixed
Generated from protobuf field <code>optional bool inclusive_end = 14;</code>
$key  : mixed
Generated from protobuf field <code>optional bytes key = 10;</code>
$limit  : mixed
Generated from protobuf field <code>optional uint32 limit = 4;</code>
$namespace  : mixed
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Namespace namespace = 19;</code>
$on_error  : mixed
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ErrorMode on_error = 17;</code>
$order  : mixed
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Order order = 20;</code>
$reduce  : mixed
Generated from protobuf field <code>optional bool reduce = 6;</code>
$scan_consistency  : mixed
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ScanConsistency scan_consistency = 5;</code>
$skip  : mixed
Generated from protobuf field <code>optional uint32 skip = 3;</code>
$start_key  : mixed
Generated from protobuf field <code>optional bytes start_key = 12;</code>
$start_key_doc_id  : mixed
Generated from protobuf field <code>optional string start_key_doc_id = 15;</code>
$view_name  : mixed
Generated from protobuf field <code>string view_name = 2;</code>
$keys  : mixed
Generated from protobuf field <code>repeated bytes keys = 11;</code>
__construct()  : mixed
Constructor.
clearDebug()  : mixed
clearEndKey()  : mixed
clearEndKeyDocId()  : mixed
clearGroup()  : mixed
clearGroupLevel()  : mixed
clearInclusiveEnd()  : mixed
clearKey()  : mixed
clearLimit()  : mixed
clearNamespace()  : mixed
clearOnError()  : mixed
clearOrder()  : mixed
clearReduce()  : mixed
clearScanConsistency()  : mixed
clearSkip()  : mixed
clearStartKey()  : mixed
clearStartKeyDocId()  : mixed
getBucketName()  : string
Generated from protobuf field <code>string bucket_name = 8;</code>
getDebug()  : bool
Generated from protobuf field <code>optional bool debug = 18;</code>
getDesignDocumentName()  : string
Generated from protobuf field <code>string design_document_name = 1;</code>
getEndKey()  : string
Generated from protobuf field <code>optional bytes end_key = 13;</code>
getEndKeyDocId()  : string
Generated from protobuf field <code>optional string end_key_doc_id = 16;</code>
getGroup()  : bool
Generated from protobuf field <code>optional bool group = 7;</code>
getGroupLevel()  : int
Generated from protobuf field <code>optional uint32 group_level = 9;</code>
getInclusiveEnd()  : bool
Generated from protobuf field <code>optional bool inclusive_end = 14;</code>
getKey()  : string
Generated from protobuf field <code>optional bytes key = 10;</code>
getKeys()  : RepeatedField
Generated from protobuf field <code>repeated bytes keys = 11;</code>
getLimit()  : int
Generated from protobuf field <code>optional uint32 limit = 4;</code>
getNamespace()  : int
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Namespace namespace = 19;</code>
getOnError()  : int
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ErrorMode on_error = 17;</code>
getOrder()  : int
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Order order = 20;</code>
getReduce()  : bool
Generated from protobuf field <code>optional bool reduce = 6;</code>
getScanConsistency()  : int
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ScanConsistency scan_consistency = 5;</code>
getSkip()  : int
Generated from protobuf field <code>optional uint32 skip = 3;</code>
getStartKey()  : string
Generated from protobuf field <code>optional bytes start_key = 12;</code>
getStartKeyDocId()  : string
Generated from protobuf field <code>optional string start_key_doc_id = 15;</code>
getViewName()  : string
Generated from protobuf field <code>string view_name = 2;</code>
hasDebug()  : mixed
hasEndKey()  : mixed
hasEndKeyDocId()  : mixed
hasGroup()  : mixed
hasGroupLevel()  : mixed
hasInclusiveEnd()  : mixed
hasKey()  : mixed
hasLimit()  : mixed
hasNamespace()  : mixed
hasOnError()  : mixed
hasOrder()  : mixed
hasReduce()  : mixed
hasScanConsistency()  : mixed
hasSkip()  : mixed
hasStartKey()  : mixed
hasStartKeyDocId()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>string bucket_name = 8;</code>
setDebug()  : $this
Generated from protobuf field <code>optional bool debug = 18;</code>
setDesignDocumentName()  : $this
Generated from protobuf field <code>string design_document_name = 1;</code>
setEndKey()  : $this
Generated from protobuf field <code>optional bytes end_key = 13;</code>
setEndKeyDocId()  : $this
Generated from protobuf field <code>optional string end_key_doc_id = 16;</code>
setGroup()  : $this
Generated from protobuf field <code>optional bool group = 7;</code>
setGroupLevel()  : $this
Generated from protobuf field <code>optional uint32 group_level = 9;</code>
setInclusiveEnd()  : $this
Generated from protobuf field <code>optional bool inclusive_end = 14;</code>
setKey()  : $this
Generated from protobuf field <code>optional bytes key = 10;</code>
setKeys()  : $this
Generated from protobuf field <code>repeated bytes keys = 11;</code>
setLimit()  : $this
Generated from protobuf field <code>optional uint32 limit = 4;</code>
setNamespace()  : $this
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Namespace namespace = 19;</code>
setOnError()  : $this
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ErrorMode on_error = 17;</code>
setOrder()  : $this
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Order order = 20;</code>
setReduce()  : $this
Generated from protobuf field <code>optional bool reduce = 6;</code>
setScanConsistency()  : $this
Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ScanConsistency scan_consistency = 5;</code>
setSkip()  : $this
Generated from protobuf field <code>optional uint32 skip = 3;</code>
setStartKey()  : $this
Generated from protobuf field <code>optional bytes start_key = 12;</code>
setStartKeyDocId()  : $this
Generated from protobuf field <code>optional string start_key_doc_id = 15;</code>
setViewName()  : $this
Generated from protobuf field <code>string view_name = 2;</code>

Properties

$bucket_name

Generated from protobuf field <code>string bucket_name = 8;</code>

protected mixed $bucket_name = ''

$debug

Generated from protobuf field <code>optional bool debug = 18;</code>

protected mixed $debug = null

$design_document_name

Generated from protobuf field <code>string design_document_name = 1;</code>

protected mixed $design_document_name = ''

$end_key

Generated from protobuf field <code>optional bytes end_key = 13;</code>

protected mixed $end_key = null

$end_key_doc_id

Generated from protobuf field <code>optional string end_key_doc_id = 16;</code>

protected mixed $end_key_doc_id = null

$group

Generated from protobuf field <code>optional bool group = 7;</code>

protected mixed $group = null

$group_level

Generated from protobuf field <code>optional uint32 group_level = 9;</code>

protected mixed $group_level = null

$inclusive_end

Generated from protobuf field <code>optional bool inclusive_end = 14;</code>

protected mixed $inclusive_end = null

$key

Generated from protobuf field <code>optional bytes key = 10;</code>

protected mixed $key = null

$limit

Generated from protobuf field <code>optional uint32 limit = 4;</code>

protected mixed $limit = null

$namespace

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Namespace namespace = 19;</code>

protected mixed $namespace = null

$on_error

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ErrorMode on_error = 17;</code>

protected mixed $on_error = null

$order

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Order order = 20;</code>

protected mixed $order = null

$reduce

Generated from protobuf field <code>optional bool reduce = 6;</code>

protected mixed $reduce = null

$scan_consistency

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ScanConsistency scan_consistency = 5;</code>

protected mixed $scan_consistency = null

$skip

Generated from protobuf field <code>optional uint32 skip = 3;</code>

protected mixed $skip = null

$start_key

Generated from protobuf field <code>optional bytes start_key = 12;</code>

protected mixed $start_key = null

$start_key_doc_id

Generated from protobuf field <code>optional string start_key_doc_id = 15;</code>

protected mixed $start_key_doc_id = null

$view_name

Generated from protobuf field <code>string view_name = 2;</code>

protected mixed $view_name = ''

$keys

Generated from protobuf field <code>repeated bytes keys = 11;</code>

private mixed $keys

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $bucket_name
@type string $design_document_name
@type string $view_name
@type int $skip
@type int $limit
@type int $scan_consistency
@type bool $reduce
@type bool $group
@type int $group_level
@type string $key
@type array<string>|\Google\Protobuf\Internal\RepeatedField $keys
@type string $start_key
@type string $end_key
@type bool $inclusive_end
@type string $start_key_doc_id
@type string $end_key_doc_id
@type int $on_error
@type bool $debug
@type int $namespace
@type int $order

}

Return values
mixed —

clearEndKeyDocId()

public clearEndKeyDocId() : mixed
Return values
mixed —

clearGroupLevel()

public clearGroupLevel() : mixed
Return values
mixed —

clearInclusiveEnd()

public clearInclusiveEnd() : mixed
Return values
mixed —

clearNamespace()

public clearNamespace() : mixed
Return values
mixed —

clearScanConsistency()

public clearScanConsistency() : mixed
Return values
mixed —

clearStartKeyDocId()

public clearStartKeyDocId() : mixed
Return values
mixed —

getBucketName()

Generated from protobuf field <code>string bucket_name = 8;</code>

public getBucketName() : string
Return values
string —

getDebug()

Generated from protobuf field <code>optional bool debug = 18;</code>

public getDebug() : bool
Return values
bool —

getDesignDocumentName()

Generated from protobuf field <code>string design_document_name = 1;</code>

public getDesignDocumentName() : string
Return values
string —

getEndKey()

Generated from protobuf field <code>optional bytes end_key = 13;</code>

public getEndKey() : string
Return values
string —

getEndKeyDocId()

Generated from protobuf field <code>optional string end_key_doc_id = 16;</code>

public getEndKeyDocId() : string
Return values
string —

getGroup()

Generated from protobuf field <code>optional bool group = 7;</code>

public getGroup() : bool
Return values
bool —

getGroupLevel()

Generated from protobuf field <code>optional uint32 group_level = 9;</code>

public getGroupLevel() : int
Return values
int —

getInclusiveEnd()

Generated from protobuf field <code>optional bool inclusive_end = 14;</code>

public getInclusiveEnd() : bool
Return values
bool —

getKey()

Generated from protobuf field <code>optional bytes key = 10;</code>

public getKey() : string
Return values
string —

getKeys()

Generated from protobuf field <code>repeated bytes keys = 11;</code>

public getKeys() : RepeatedField
Return values
RepeatedField —

getLimit()

Generated from protobuf field <code>optional uint32 limit = 4;</code>

public getLimit() : int
Return values
int —

getNamespace()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Namespace namespace = 19;</code>

public getNamespace() : int
Return values
int —

getOnError()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ErrorMode on_error = 17;</code>

public getOnError() : int
Return values
int —

getOrder()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Order order = 20;</code>

public getOrder() : int
Return values
int —

getReduce()

Generated from protobuf field <code>optional bool reduce = 6;</code>

public getReduce() : bool
Return values
bool —

getScanConsistency()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ScanConsistency scan_consistency = 5;</code>

public getScanConsistency() : int
Return values
int —

getSkip()

Generated from protobuf field <code>optional uint32 skip = 3;</code>

public getSkip() : int
Return values
int —

getStartKey()

Generated from protobuf field <code>optional bytes start_key = 12;</code>

public getStartKey() : string
Return values
string —

getStartKeyDocId()

Generated from protobuf field <code>optional string start_key_doc_id = 15;</code>

public getStartKeyDocId() : string
Return values
string —

getViewName()

Generated from protobuf field <code>string view_name = 2;</code>

public getViewName() : string
Return values
string —

hasEndKeyDocId()

public hasEndKeyDocId() : mixed
Return values
mixed —

hasInclusiveEnd()

public hasInclusiveEnd() : mixed
Return values
mixed —

hasScanConsistency()

public hasScanConsistency() : mixed
Return values
mixed —

hasStartKeyDocId()

public hasStartKeyDocId() : mixed
Return values
mixed —

setBucketName()

Generated from protobuf field <code>string bucket_name = 8;</code>

public setBucketName(string $var) : $this
Parameters
$var : string
Return values
$this —

setDebug()

Generated from protobuf field <code>optional bool debug = 18;</code>

public setDebug(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setDesignDocumentName()

Generated from protobuf field <code>string design_document_name = 1;</code>

public setDesignDocumentName(string $var) : $this
Parameters
$var : string
Return values
$this —

setEndKey()

Generated from protobuf field <code>optional bytes end_key = 13;</code>

public setEndKey(string $var) : $this
Parameters
$var : string
Return values
$this —

setEndKeyDocId()

Generated from protobuf field <code>optional string end_key_doc_id = 16;</code>

public setEndKeyDocId(string $var) : $this
Parameters
$var : string
Return values
$this —

setGroup()

Generated from protobuf field <code>optional bool group = 7;</code>

public setGroup(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setGroupLevel()

Generated from protobuf field <code>optional uint32 group_level = 9;</code>

public setGroupLevel(int $var) : $this
Parameters
$var : int
Return values
$this —

setInclusiveEnd()

Generated from protobuf field <code>optional bool inclusive_end = 14;</code>

public setInclusiveEnd(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setKey()

Generated from protobuf field <code>optional bytes key = 10;</code>

public setKey(string $var) : $this
Parameters
$var : string
Return values
$this —

setKeys()

Generated from protobuf field <code>repeated bytes keys = 11;</code>

public setKeys(array<string|int, string>|RepeatedField $var) : $this
Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this —

setLimit()

Generated from protobuf field <code>optional uint32 limit = 4;</code>

public setLimit(int $var) : $this
Parameters
$var : int
Return values
$this —

setNamespace()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Namespace namespace = 19;</code>

public setNamespace(int $var) : $this
Parameters
$var : int
Return values
$this —

setOnError()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ErrorMode on_error = 17;</code>

public setOnError(int $var) : $this
Parameters
$var : int
Return values
$this —

setOrder()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.Order order = 20;</code>

public setOrder(int $var) : $this
Parameters
$var : int
Return values
$this —

setReduce()

Generated from protobuf field <code>optional bool reduce = 6;</code>

public setReduce(bool $var) : $this
Parameters
$var : bool
Return values
$this —

setScanConsistency()

Generated from protobuf field <code>optional .couchbase.view.v1.ViewQueryRequest.ScanConsistency scan_consistency = 5;</code>

public setScanConsistency(int $var) : $this
Parameters
$var : int
Return values
$this —

setSkip()

Generated from protobuf field <code>optional uint32 skip = 3;</code>

public setSkip(int $var) : $this
Parameters
$var : int
Return values
$this —

setStartKey()

Generated from protobuf field <code>optional bytes start_key = 12;</code>

public setStartKey(string $var) : $this
Parameters
$var : string
Return values
$this —

setStartKeyDocId()

Generated from protobuf field <code>optional string start_key_doc_id = 15;</code>

public setStartKeyDocId(string $var) : $this
Parameters
$var : string
Return values
$this —

setViewName()

Generated from protobuf field <code>string view_name = 2;</code>

public setViewName(string $var) : $this
Parameters
$var : string
Return values
$this — 

        

        
    




    

    

                

    

        

            
Search results