Documentation

CreateIndexRequest extends Message
in package

CreateIndexRequest does not use Index because of the uuid field.

Generated from protobuf message couchbase.admin.search.v1.CreateIndexRequest

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>optional string bucket_name = 10;</code>
$name  : mixed
Generated from protobuf field <code>string name = 1;</code>
$prev_index_uuid  : mixed
Generated from protobuf field <code>optional string prev_index_uuid = 4;</code>
$scope_name  : mixed
Generated from protobuf field <code>optional string scope_name = 11;</code>
$source_name  : mixed
Generated from protobuf field <code>optional string source_name = 5;</code>
$source_type  : mixed
Generated from protobuf field <code>optional string source_type = 7;</code>
$source_uuid  : mixed
Generated from protobuf field <code>optional string source_uuid = 8;</code>
$type  : mixed
Generated from protobuf field <code>string type = 9;</code>
$params  : mixed
Generated from protobuf field <code>map<string, bytes> params = 2;</code>
$plan_params  : mixed
Generated from protobuf field <code>map<string, bytes> plan_params = 3;</code>
$source_params  : mixed
Generated from protobuf field <code>map<string, bytes> source_params = 6;</code>
__construct()  : mixed
Constructor.
clearBucketName()  : mixed
clearPrevIndexUuid()  : mixed
clearScopeName()  : mixed
clearSourceName()  : mixed
clearSourceType()  : mixed
clearSourceUuid()  : mixed
getBucketName()  : string
Generated from protobuf field <code>optional string bucket_name = 10;</code>
getName()  : string
Generated from protobuf field <code>string name = 1;</code>
getParams()  : MapField
Generated from protobuf field <code>map<string, bytes> params = 2;</code>
getPlanParams()  : MapField
Generated from protobuf field <code>map<string, bytes> plan_params = 3;</code>
getPrevIndexUuid()  : string
Generated from protobuf field <code>optional string prev_index_uuid = 4;</code>
getScopeName()  : string
Generated from protobuf field <code>optional string scope_name = 11;</code>
getSourceName()  : string
Generated from protobuf field <code>optional string source_name = 5;</code>
getSourceParams()  : MapField
Generated from protobuf field <code>map<string, bytes> source_params = 6;</code>
getSourceType()  : string
Generated from protobuf field <code>optional string source_type = 7;</code>
getSourceUuid()  : string
Generated from protobuf field <code>optional string source_uuid = 8;</code>
getType()  : string
Generated from protobuf field <code>string type = 9;</code>
hasBucketName()  : mixed
hasPrevIndexUuid()  : mixed
hasScopeName()  : mixed
hasSourceName()  : mixed
hasSourceType()  : mixed
hasSourceUuid()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>optional string bucket_name = 10;</code>
setName()  : $this
Generated from protobuf field <code>string name = 1;</code>
setParams()  : $this
Generated from protobuf field <code>map<string, bytes> params = 2;</code>
setPlanParams()  : $this
Generated from protobuf field <code>map<string, bytes> plan_params = 3;</code>
setPrevIndexUuid()  : $this
Generated from protobuf field <code>optional string prev_index_uuid = 4;</code>
setScopeName()  : $this
Generated from protobuf field <code>optional string scope_name = 11;</code>
setSourceName()  : $this
Generated from protobuf field <code>optional string source_name = 5;</code>
setSourceParams()  : $this
Generated from protobuf field <code>map<string, bytes> source_params = 6;</code>
setSourceType()  : $this
Generated from protobuf field <code>optional string source_type = 7;</code>
setSourceUuid()  : $this
Generated from protobuf field <code>optional string source_uuid = 8;</code>
setType()  : $this
Generated from protobuf field <code>string type = 9;</code>

Properties

$bucket_name

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

protected mixed $bucket_name = null

$name

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

protected mixed $name = ''

$prev_index_uuid

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

protected mixed $prev_index_uuid = null

$scope_name

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

protected mixed $scope_name = null

$source_name

Generated from protobuf field <code>optional string source_name = 5;</code>

protected mixed $source_name = null

$source_type

Generated from protobuf field <code>optional string source_type = 7;</code>

protected mixed $source_type = null

$source_uuid

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

protected mixed $source_uuid = null

$type

Generated from protobuf field <code>string type = 9;</code>

protected mixed $type = ''

$params

Generated from protobuf field <code>map<string, bytes> params = 2;</code>

private mixed $params

$plan_params

Generated from protobuf field <code>map<string, bytes> plan_params = 3;</code>

private mixed $plan_params

$source_params

Generated from protobuf field <code>map<string, bytes> source_params = 6;</code>

private mixed $source_params

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 $name
@type array|\Google\Protobuf\Internal\MapField $params
@type array|\Google\Protobuf\Internal\MapField $plan_params
@type string $prev_index_uuid
@type string $source_name
@type array|\Google\Protobuf\Internal\MapField $source_params
@type string $source_type
@type string $source_uuid
@type string $type
@type string $bucket_name
@type string $scope_name

}

Return values
mixed —

clearPrevIndexUuid()

public clearPrevIndexUuid() : mixed
Return values
mixed —

getBucketName()

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

public getBucketName() : string
Return values
string —

getName()

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

public getName() : string
Return values
string —

getParams()

Generated from protobuf field <code>map<string, bytes> params = 2;</code>

public getParams() : MapField
Return values
MapField —

getPlanParams()

Generated from protobuf field <code>map<string, bytes> plan_params = 3;</code>

public getPlanParams() : MapField
Return values
MapField —

getPrevIndexUuid()

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

public getPrevIndexUuid() : string
Return values
string —

getScopeName()

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

public getScopeName() : string
Return values
string —

getSourceName()

Generated from protobuf field <code>optional string source_name = 5;</code>

public getSourceName() : string
Return values
string —

getSourceParams()

Generated from protobuf field <code>map<string, bytes> source_params = 6;</code>

public getSourceParams() : MapField
Return values
MapField —

getSourceType()

Generated from protobuf field <code>optional string source_type = 7;</code>

public getSourceType() : string
Return values
string —

getSourceUuid()

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

public getSourceUuid() : string
Return values
string —

getType()

Generated from protobuf field <code>string type = 9;</code>

public getType() : string
Return values
string —

setBucketName()

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

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

setName()

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

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

setParams()

Generated from protobuf field <code>map<string, bytes> params = 2;</code>

public setParams(array<string|int, mixed>|MapField $var) : $this
Parameters
$var : array<string|int, mixed>|MapField
Return values
$this —

setPlanParams()

Generated from protobuf field <code>map<string, bytes> plan_params = 3;</code>

public setPlanParams(array<string|int, mixed>|MapField $var) : $this
Parameters
$var : array<string|int, mixed>|MapField
Return values
$this —

setPrevIndexUuid()

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

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

setScopeName()

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

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

setSourceName()

Generated from protobuf field <code>optional string source_name = 5;</code>

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

setSourceParams()

Generated from protobuf field <code>map<string, bytes> source_params = 6;</code>

public setSourceParams(array<string|int, mixed>|MapField $var) : $this
Parameters
$var : array<string|int, mixed>|MapField
Return values
$this —

setSourceType()

Generated from protobuf field <code>optional string source_type = 7;</code>

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

setSourceUuid()

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

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

setType()

Generated from protobuf field <code>string type = 9;</code>

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

        

        
    




    

    

                

    

        

            
Search results