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 messagegoogle.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
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
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Dms V1 Client - Class MultiEntityRename (2.0.6)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.6 (latest)](/php/docs/reference/cloud-dms/latest/V1.MultiEntityRename)\n- [2.0.5](/php/docs/reference/cloud-dms/2.0.5/V1.MultiEntityRename)\n- [1.5.5](/php/docs/reference/cloud-dms/1.5.5/V1.MultiEntityRename)\n- [1.4.2](/php/docs/reference/cloud-dms/1.4.2/V1.MultiEntityRename)\n- [1.3.0](/php/docs/reference/cloud-dms/1.3.0/V1.MultiEntityRename)\n- [1.2.1](/php/docs/reference/cloud-dms/1.2.1/V1.MultiEntityRename)\n- [1.1.0](/php/docs/reference/cloud-dms/1.1.0/V1.MultiEntityRename)\n- [1.0.5](/php/docs/reference/cloud-dms/1.0.5/V1.MultiEntityRename) \nReference documentation and code samples for the Google Cloud Dms V1 Client class MultiEntityRename.\n\nOptions to configure rule type MultiEntityRename.\n\nThe rule is used to rename multiple entities.\nThe rule filter field can refer to one or more entities.\nThe rule scope can be one of: Database, Schema, Table, Column, Constraint,\nIndex, View, Function, Stored Procedure, Materialized View, Sequence, UDT\n\nGenerated from protobuf message `google.cloud.clouddms.v1.MultiEntityRename`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ CloudDms \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getNewNamePattern\n\nOptional. The pattern used to generate the new entity's name. This pattern\nmust include the characters '{name}', which will be replaced with the name\nof the original entity. For example, the pattern 't_{name}' for an entity\nname jobs would be converted to 't_jobs'.\n\nIf unspecified, the default value for this field is '{name}'\n\n### setNewNamePattern\n\nOptional. The pattern used to generate the new entity's name. This pattern\nmust include the characters '{name}', which will be replaced with the name\nof the original entity. For example, the pattern 't_{name}' for an entity\nname jobs would be converted to 't_jobs'.\n\nIf unspecified, the default value for this field is '{name}'\n\n### getSourceNameTransformation\n\nOptional. Additional transformation that can be done on the source entity\nname before it is being used by the new_name_pattern, for example lower\ncase. If no transformation is desired, use NO_TRANSFORMATION\n\n### setSourceNameTransformation\n\nOptional. Additional transformation that can be done on the source entity\nname before it is being used by the new_name_pattern, for example lower\ncase. If no transformation is desired, use NO_TRANSFORMATION"]]
