Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::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
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#new_name_pattern
defnew_name_pattern()->::String
Returns
(::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}'
#new_name_pattern=
defnew_name_pattern=(value)->::String
Parameter
value (::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}'
Returns
(::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}'
(::Google::Cloud::CloudDMS::V1::EntityNameTransformation) — 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
value (::Google::Cloud::CloudDMS::V1::EntityNameTransformation) — 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
(::Google::Cloud::CloudDMS::V1::EntityNameTransformation) — 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-09 UTC."],[],[],null,["# Cloud Database Migration Service V1 API - Class Google::Cloud::CloudDMS::V1::MultiEntityRename (v1.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.3.1 (latest)](/ruby/docs/reference/google-cloud-cloud_dms-v1/latest/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [1.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.3.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [1.2.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.2.2/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [1.1.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.1.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [1.0.1](/ruby/docs/reference/google-cloud-cloud_dms-v1/1.0.1/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.8.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.8.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.7.2](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.7.2/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.6.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.6.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.5.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.5.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.4.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.4.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.3.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.3.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.2.0](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.2.0/Google-Cloud-CloudDMS-V1-MultiEntityRename)\n- [0.1.5](/ruby/docs/reference/google-cloud-cloud_dms-v1/0.1.5/Google-Cloud-CloudDMS-V1-MultiEntityRename) \nReference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::MultiEntityRename.\n\nOptions to configure rule type MultiEntityRename.\nThe rule is used to rename multiple entities.\n\n\nThe rule filter field can refer to one or more entities.\n\n\u003cbr /\u003e\n\nThe rule scope can be one of: Database, Schema, Table, Column, Constraint,\nIndex, View, Function, Stored Procedure, Materialized View, Sequence, UDT \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #new_name_pattern\n\n def new_name_pattern() -\u003e ::String\n\n**Returns**\n\n- (::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'.\n\n If unspecified, the default value for this field is '{name}'\n\n### #new_name_pattern=\n\n def new_name_pattern=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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'.\n\n\nIf unspecified, the default value for this field is '{name}' \n**Returns**\n\n- (::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'.\n\n If unspecified, the default value for this field is '{name}'\n\n### #source_name_transformation\n\n def source_name_transformation() -\u003e ::Google::Cloud::CloudDMS::V1::EntityNameTransformation\n\n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::EntityNameTransformation](./Google-Cloud-CloudDMS-V1-EntityNameTransformation)) --- 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\n\n### #source_name_transformation=\n\n def source_name_transformation=(value) -\u003e ::Google::Cloud::CloudDMS::V1::EntityNameTransformation\n\n**Parameter**\n\n- **value** ([::Google::Cloud::CloudDMS::V1::EntityNameTransformation](./Google-Cloud-CloudDMS-V1-EntityNameTransformation)) --- 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 \n**Returns**\n\n- ([::Google::Cloud::CloudDMS::V1::EntityNameTransformation](./Google-Cloud-CloudDMS-V1-EntityNameTransformation)) --- 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"]]