# Google Cloud Dms V1 Client - Class ConstraintEntity (2.1.3)

2.1.3 (latest) 2.1.2 2.0.6 1.5.5 1.4.2 1.3.0 1.2.1 1.1.0 1.0.5 Reference documentation and code samples for the Google Cloud Dms V1 Client class ConstraintEntity.

Constraint is not used as an independent entity, it is retrieved
as part of another entity such as Table or View.

Generated from protobuf message `google.cloud.clouddms.v1.ConstraintEntity`

## 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 table constraint. |
| `↳ type` | `string` Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported). |
| `↳ table_columns` | `string[]` Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key. |
| `↳ custom_features` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` Custom engine specific features. |
| `↳ reference_columns` | `string[]` Reference columns which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key. |
| `↳ reference_table` | `string` Reference table which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key. |
| `↳ table_name` | `string` Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined. |

### getName

The name of the table constraint.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setName

The name of the table constraint.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getType

Type of constraint, for example unique, primary key, foreign key (currently
only primary key is supported).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setType

Type of constraint, for example unique, primary key, foreign key (currently
only primary key is supported).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTableColumns

Table columns used as part of the Constraint, for example primary key
constraint should list the columns which constitutes the key.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setTableColumns

Table columns used as part of the Constraint, for example primary key
constraint should list the columns which constitutes the key.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getCustomFeatures

Custom engine specific features.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct|null` |   |

### hasCustomFeatures

### clearCustomFeatures

### setCustomFeatures

Custom engine specific features.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Struct` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReferenceColumns

Reference columns which may be associated with the constraint. For example,
if the constraint is a FOREIGN_KEY, this represents the list of full names
of referenced columns by the foreign key.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### setReferenceColumns

Reference columns which may be associated with the constraint. For example,
if the constraint is a FOREIGN_KEY, this represents the list of full names
of referenced columns by the foreign key.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getReferenceTable

Reference table which may be associated with the constraint. For example,
if the constraint is a FOREIGN_KEY, this represents the list of full name
of the referenced table by the foreign key.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setReferenceTable

Reference table which may be associated with the constraint. For example,
if the constraint is a FOREIGN_KEY, this represents the list of full name
of the referenced table by the foreign key.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTableName

Table which is associated with the constraint. In case the constraint
is defined on a table, this field is left empty as this information is
stored in parent_name. However, if constraint is defined on a view, this
field stores the table name on which the view is defined.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setTableName

Table which is associated with the constraint. In case the constraint
is defined on a table, this field is left empty as this information is
stored in parent_name. However, if constraint is defined on a view, this
field stores the table name on which the view is defined.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |