Reference documentation and code samples for the Google Cloud Dms V1 Client class MappingRule.
Definition of a transformation that is to be applied to a group of entities in the source schema. Several such transformations can be applied to an entity sequentially to define the corresponding entity in the target schema.
Generated from protobuf message google.cloud.clouddms.v1.MappingRule
Namespace
Google \ Cloud \ CloudDms \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}. |
↳ display_name |
string
Optional. A human readable name |
↳ state |
int
Optional. The mapping rule state |
↳ rule_scope |
int
Required. The rule scope |
↳ filter |
MappingRuleFilter
Required. The rule filter |
↳ rule_order |
int|string
Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. |
↳ revision_id |
string
Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. |
↳ revision_create_time |
Google\Protobuf\Timestamp
Output only. The timestamp that the revision was created. |
↳ single_entity_rename |
SingleEntityRename
Optional. Rule to specify how a single entity should be renamed. |
↳ multi_entity_rename |
MultiEntityRename
Optional. Rule to specify how multiple entities should be renamed. |
↳ entity_move |
EntityMove
Optional. Rule to specify how multiple entities should be relocated into a different schema. |
↳ single_column_change |
SingleColumnChange
Optional. Rule to specify how a single column is converted. |
↳ multi_column_data_type_change |
MultiColumnDatatypeChange
Optional. Rule to specify how multiple columns should be converted to a different data type. |
↳ conditional_column_set_value |
ConditionalColumnSetValue
Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria. |
↳ convert_rowid_column |
ConvertRowIdToColumn
Optional. Rule to specify how multiple tables should be converted with an additional rowid column. |
↳ set_table_primary_key |
SetTablePrimaryKey
Optional. Rule to specify the primary key for a table |
↳ single_package_change |
SinglePackageChange
Optional. Rule to specify how a single package is converted. |
↳ source_sql_change |
SourceSqlChange
Optional. Rule to change the sql code for an entity, for example, function, procedure. |
↳ filter_table_columns |
FilterTableColumns
Optional. Rule to specify the list of columns to include or exclude from a table. |
getName
Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Optional. A human readable name
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Optional. A human readable name
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
Optional. The mapping rule state
| Returns | |
|---|---|
| Type | Description |
int |
|
setState
Optional. The mapping rule state
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleScope
Required. The rule scope
| Returns | |
|---|---|
| Type | Description |
int |
|
setRuleScope
Required. The rule scope
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Required. The rule filter
| Returns | |
|---|---|
| Type | Description |
MappingRuleFilter|null |
|
hasFilter
clearFilter
setFilter
Required. The rule filter
| Parameter | |
|---|---|
| Name | Description |
var |
MappingRuleFilter
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRuleOrder
Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setRuleOrder
Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevisionId
Output only. The revision ID of the mapping rule.
A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRevisionId
Output only. The revision ID of the mapping rule.
A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRevisionCreateTime
Output only. The timestamp that the revision was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasRevisionCreateTime
clearRevisionCreateTime
setRevisionCreateTime
Output only. The timestamp that the revision was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSingleEntityRename
Optional. Rule to specify how a single entity should be renamed.
| Returns | |
|---|---|
| Type | Description |
SingleEntityRename|null |
|
hasSingleEntityRename
setSingleEntityRename
Optional. Rule to specify how a single entity should be renamed.
| Parameter | |
|---|---|
| Name | Description |
var |
SingleEntityRename
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMultiEntityRename
Optional. Rule to specify how multiple entities should be renamed.
| Returns | |
|---|---|
| Type | Description |
MultiEntityRename|null |
|
hasMultiEntityRename
setMultiEntityRename
Optional. Rule to specify how multiple entities should be renamed.
| Parameter | |
|---|---|
| Name | Description |
var |
MultiEntityRename
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityMove
Optional. Rule to specify how multiple entities should be relocated into a different schema.
| Returns | |
|---|---|
| Type | Description |
EntityMove|null |
|
hasEntityMove
setEntityMove
Optional. Rule to specify how multiple entities should be relocated into a different schema.
| Parameter | |
|---|---|
| Name | Description |
var |
EntityMove
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSingleColumnChange
Optional. Rule to specify how a single column is converted.
| Returns | |
|---|---|
| Type | Description |
SingleColumnChange|null |
|
hasSingleColumnChange
setSingleColumnChange
Optional. Rule to specify how a single column is converted.
| Parameter | |
|---|---|
| Name | Description |
var |
SingleColumnChange
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMultiColumnDataTypeChange
Optional. Rule to specify how multiple columns should be converted to a different data type.
| Returns | |
|---|---|
| Type | Description |
MultiColumnDatatypeChange|null |
|
hasMultiColumnDataTypeChange
setMultiColumnDataTypeChange
Optional. Rule to specify how multiple columns should be converted to a different data type.
| Parameter | |
|---|---|
| Name | Description |
var |
MultiColumnDatatypeChange
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConditionalColumnSetValue
Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
| Returns | |
|---|---|
| Type | Description |
ConditionalColumnSetValue|null |
|
hasConditionalColumnSetValue
setConditionalColumnSetValue
Optional. Rule to specify how the data contained in a column should be transformed (such as trimmed, rounded, etc) provided that the data meets certain criteria.
| Parameter | |
|---|---|
| Name | Description |
var |
ConditionalColumnSetValue
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getConvertRowidColumn
Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
| Returns | |
|---|---|
| Type | Description |
ConvertRowIdToColumn|null |
|
hasConvertRowidColumn
setConvertRowidColumn
Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
| Parameter | |
|---|---|
| Name | Description |
var |
ConvertRowIdToColumn
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSetTablePrimaryKey
Optional. Rule to specify the primary key for a table
| Returns | |
|---|---|
| Type | Description |
SetTablePrimaryKey|null |
|
hasSetTablePrimaryKey
setSetTablePrimaryKey
Optional. Rule to specify the primary key for a table
| Parameter | |
|---|---|
| Name | Description |
var |
SetTablePrimaryKey
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSinglePackageChange
Optional. Rule to specify how a single package is converted.
| Returns | |
|---|---|
| Type | Description |
SinglePackageChange|null |
|
hasSinglePackageChange
setSinglePackageChange
Optional. Rule to specify how a single package is converted.
| Parameter | |
|---|---|
| Name | Description |
var |
SinglePackageChange
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSourceSqlChange
Optional. Rule to change the sql code for an entity, for example, function, procedure.
| Returns | |
|---|---|
| Type | Description |
SourceSqlChange|null |
|
hasSourceSqlChange
setSourceSqlChange
Optional. Rule to change the sql code for an entity, for example, function, procedure.
| Parameter | |
|---|---|
| Name | Description |
var |
SourceSqlChange
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilterTableColumns
Optional. Rule to specify the list of columns to include or exclude from a table.
| Returns | |
|---|---|
| Type | Description |
FilterTableColumns|null |
|
hasFilterTableColumns
setFilterTableColumns
Optional. Rule to specify the list of columns to include or exclude from a table.
| Parameter | |
|---|---|
| Name | Description |
var |
FilterTableColumns
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetails
| Returns | |
|---|---|
| Type | Description |
string |
|