Google Cloud Dms V1 Client - Class IndexEntity (1.3.0)

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
NameDescription
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
TypeDescription
string

setName

The name of the index.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getType

Type of index, for example B-TREE.

Returns
TypeDescription
string

setType

Type of index, for example B-TREE.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTableColumns

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

Returns
TypeDescription
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
NameDescription
var string[]
Returns
TypeDescription
$this

getUnique

Boolean value indicating whether the index is unique.

Returns
TypeDescription
bool

setUnique

Boolean value indicating whether the index is unique.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getCustomFeatures

Custom engine specific features.

Returns
TypeDescription
Google\Protobuf\Struct|null

hasCustomFeatures

clearCustomFeatures

setCustomFeatures

Custom engine specific features.

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this