Google Cloud Dms V1 Client - Class IndexEntity (1.5.5)

Reference documentation and code samples for the Google Cloud Dms V1 Client class IndexEntity.

Index is not used as an independent entity, it is retrieved as part of a Table entity.

Generated from protobuf message google.cloud.clouddms.v1.IndexEntity

Namespace

Google \ Cloud \ CloudDms \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

The name of the index.

↳ type string

Type of index, for example B-TREE.

↳ table_columns array

Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index.

↳ unique bool

Boolean value indicating whether the index is unique.

↳ custom_features Google\Protobuf\Struct

Custom engine specific features.

getName

The name of the index.

Returns
Type Description
string

setName

The name of the index.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

Type of index, for example B-TREE.

Returns
Type Description
string

setType

Type of index, for example B-TREE.

Parameter
Name Description
var string
Returns
Type Description
$this

getTableColumns

Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setTableColumns

Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getUnique

Boolean value indicating whether the index is unique.

Returns
Type Description
bool

setUnique

Boolean value indicating whether the index is unique.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCustomFeatures

Custom engine specific features.

Returns
Type Description
Google\Protobuf\Struct|null

hasCustomFeatures

clearCustomFeatures

setCustomFeatures

Custom engine specific features.

Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this