Documentation

CreateIndexRequest extends Message
in package

Generated from protobuf message <code>couchbase.admin.query.v1.CreateIndexRequest</code>

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>string bucket_name = 1;</code>
$collection_name  : mixed
Generated from protobuf field <code>optional string collection_name = 3;</code>
$deferred  : mixed
Generated from protobuf field <code>optional bool deferred = 7;</code>
$ignore_if_exists  : mixed
Generated from protobuf field <code>optional bool ignore_if_exists = 8;</code>
$name  : mixed
Generated from protobuf field <code>string name = 4;</code>
$num_replicas  : mixed
Generated from protobuf field <code>optional int32 num_replicas = 5;</code>
$scope_name  : mixed
Generated from protobuf field <code>optional string scope_name = 2;</code>
$fields  : mixed
Generated from protobuf field <code>repeated string fields = 6;</code>
__construct()  : mixed
Constructor.
clearCollectionName()  : mixed
clearDeferred()  : mixed
clearIgnoreIfExists()  : mixed
clearNumReplicas()  : mixed
clearScopeName()  : mixed
getBucketName()  : string
Generated from protobuf field <code>string bucket_name = 1;</code>
getCollectionName()  : string
Generated from protobuf field <code>optional string collection_name = 3;</code>
getDeferred()  : bool
Generated from protobuf field <code>optional bool deferred = 7;</code>
getFields()  : RepeatedField
Generated from protobuf field <code>repeated string fields = 6;</code>
getIgnoreIfExists()  : bool
Generated from protobuf field <code>optional bool ignore_if_exists = 8;</code>
getName()  : string
Generated from protobuf field <code>string name = 4;</code>
getNumReplicas()  : int
Generated from protobuf field <code>optional int32 num_replicas = 5;</code>
getScopeName()  : string
Generated from protobuf field <code>optional string scope_name = 2;</code>
hasCollectionName()  : mixed
hasDeferred()  : mixed
hasIgnoreIfExists()  : mixed
hasNumReplicas()  : mixed
hasScopeName()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>string bucket_name = 1;</code>
setCollectionName()  : $this
Generated from protobuf field <code>optional string collection_name = 3;</code>
setDeferred()  : $this
Generated from protobuf field <code>optional bool deferred = 7;</code>
setFields()  : $this
Generated from protobuf field <code>repeated string fields = 6;</code>
setIgnoreIfExists()  : $this
Generated from protobuf field <code>optional bool ignore_if_exists = 8;</code>
setName()  : $this
Generated from protobuf field <code>string name = 4;</code>
setNumReplicas()  : $this
Generated from protobuf field <code>optional int32 num_replicas = 5;</code>
setScopeName()  : $this
Generated from protobuf field <code>optional string scope_name = 2;</code>

Properties

$bucket_name

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

protected mixed $bucket_name = ''

$collection_name

Generated from protobuf field <code>optional string collection_name = 3;</code>

protected mixed $collection_name = null

$deferred

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

protected mixed $deferred = null

$ignore_if_exists

Generated from protobuf field <code>optional bool ignore_if_exists = 8;</code>

protected mixed $ignore_if_exists = null

$name

Generated from protobuf field <code>string name = 4;</code>

protected mixed $name = ''

$num_replicas

Generated from protobuf field <code>optional int32 num_replicas = 5;</code>

protected mixed $num_replicas = null

$scope_name

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

protected mixed $scope_name = null

$fields

Generated from protobuf field <code>repeated string fields = 6;</code>

private mixed $fields

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 $scope_name
@type string $collection_name
@type string $name
@type int $num_replicas
@type array<string>|\Google\Protobuf\Internal\RepeatedField $fields
@type bool $deferred
@type bool $ignore_if_exists

}

Return values
mixed —

clearCollectionName()

public clearCollectionName() : mixed
Return values
mixed —

clearIgnoreIfExists()

public clearIgnoreIfExists() : mixed
Return values
mixed —

getBucketName()

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

public getBucketName() : string
Return values
string —

getCollectionName()

Generated from protobuf field <code>optional string collection_name = 3;</code>

public getCollectionName() : string
Return values
string —

getDeferred()

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

public getDeferred() : bool
Return values
bool —

getFields()

Generated from protobuf field <code>repeated string fields = 6;</code>

public getFields() : RepeatedField
Return values
RepeatedField —

getIgnoreIfExists()

Generated from protobuf field <code>optional bool ignore_if_exists = 8;</code>

public getIgnoreIfExists() : bool
Return values
bool —

getName()

Generated from protobuf field <code>string name = 4;</code>

public getName() : string
Return values
string —

getNumReplicas()

Generated from protobuf field <code>optional int32 num_replicas = 5;</code>

public getNumReplicas() : int
Return values
int —

getScopeName()

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

public getScopeName() : string
Return values
string —

setBucketName()

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

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

setCollectionName()

Generated from protobuf field <code>optional string collection_name = 3;</code>

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

setDeferred()

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

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

setFields()

Generated from protobuf field <code>repeated string fields = 6;</code>

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

setIgnoreIfExists()

Generated from protobuf field <code>optional bool ignore_if_exists = 8;</code>

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

setName()

Generated from protobuf field <code>string name = 4;</code>

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

setNumReplicas()

Generated from protobuf field <code>optional int32 num_replicas = 5;</code>

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

setScopeName()

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

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

        

        
    




    

    

                

    

        

            
Search results