# Google Cloud Dms V1 Client - Class MultiEntityRename (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 MultiEntityRename.

Options to configure rule type MultiEntityRename.

The rule is used to rename multiple entities.
The rule filter field can refer to one or more entities.
The rule scope can be one of: Database, Schema, Table, Column, Constraint,
Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT

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

## Namespace

Google \\ Cloud \\ CloudDms \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ new_name_pattern` | `string` Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}' |
| `↳ source_name_transformation` | `int` Optional. Additional transformation that can be done on the source entity name before it is being used by the new_name_pattern, for example lower case. If no transformation is desired, use NO_TRANSFORMATION |

### getNewNamePattern

Optional. The pattern used to generate the new entity's name. This pattern
must include the characters '{name}', which will be replaced with the name
of the original entity. For example, the pattern 't_{name}' for an entity
name jobs would be converted to 't_jobs'.

If unspecified, the default value for this field is '{name}'

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

### setNewNamePattern

Optional. The pattern used to generate the new entity's name. This pattern
must include the characters '{name}', which will be replaced with the name
of the original entity. For example, the pattern 't_{name}' for an entity
name jobs would be converted to 't_jobs'.

If unspecified, the default value for this field is '{name}'

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

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

### getSourceNameTransformation

Optional. Additional transformation that can be done on the source entity
name before it is being used by the new_name_pattern, for example lower
case. If no transformation is desired, use NO_TRANSFORMATION

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int` | Enum of type [EntityNameTransformation](https://docs.cloud.google.com/php/docs/reference/cloud-dms/latest/V1.EntityNameTransformation). |

### setSourceNameTransformation

Optional. Additional transformation that can be done on the source entity
name before it is being used by the new_name_pattern, for example lower
case. If no transformation is desired, use NO_TRANSFORMATION

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int` Enum of type [EntityNameTransformation](https://docs.cloud.google.com/php/docs/reference/cloud-dms/latest/V1.EntityNameTransformation). |

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