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.
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
↳ 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
↳ single_entity_rename
Google\Cloud\CloudDms\V1\SingleEntityRename
Optional. Rule to specify how a single entity should be renamed.
↳ multi_entity_rename
Google\Cloud\CloudDms\V1\MultiEntityRename
Optional. Rule to specify how multiple entities should be renamed.
↳ entity_move
Google\Cloud\CloudDms\V1\EntityMove
Optional. Rule to specify how multiple entities should be relocated into a different schema.
↳ single_column_change
Google\Cloud\CloudDms\V1\SingleColumnChange
Optional. Rule to specify how a single column is converted.
↳ multi_column_data_type_change
Google\Cloud\CloudDms\V1\MultiColumnDatatypeChange
Optional. Rule to specify how multiple columns should be converted to a different data type.
↳ conditional_column_set_value
Google\Cloud\CloudDms\V1\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
Google\Cloud\CloudDms\V1\ConvertRowIdToColumn
Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
↳ set_table_primary_key
↳ single_package_change
Google\Cloud\CloudDms\V1\SinglePackageChange
Optional. Rule to specify how a single package is converted.
↳ source_sql_change
Google\Cloud\CloudDms\V1\SourceSqlChange
Optional. Rule to change the sql code for an entity, for example, function, procedure.
↳ filter_table_columns
Google\Cloud\CloudDms\V1\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}.
string
setName
Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
var
string
$this
getDisplayName
Optional. A human readable name
string
setDisplayName
Optional. A human readable name
var
string
$this
getState
Optional. The mapping rule state
int
setState
Optional. The mapping rule state
var
int
$this
getRuleScope
Required. The rule scope
int
setRuleScope
Required. The rule scope
var
int
$this
getFilter
Required. The rule filter
hasFilter
clearFilter
setFilter
Required. The rule filter
$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.
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.
var
int|string
$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.
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.
var
string
$this
getRevisionCreateTime
Output only. The timestamp that the revision was created.
hasRevisionCreateTime
clearRevisionCreateTime
setRevisionCreateTime
Output only. The timestamp that the revision was created.
$this
getSingleEntityRename
Optional. Rule to specify how a single entity should be renamed.
hasSingleEntityRename
setSingleEntityRename
Optional. Rule to specify how a single entity should be renamed.
$this
getMultiEntityRename
Optional. Rule to specify how multiple entities should be renamed.
hasMultiEntityRename
setMultiEntityRename
Optional. Rule to specify how multiple entities should be renamed.
$this
getEntityMove
Optional. Rule to specify how multiple entities should be relocated into a different schema.
hasEntityMove
setEntityMove
Optional. Rule to specify how multiple entities should be relocated into a different schema.
$this
getSingleColumnChange
Optional. Rule to specify how a single column is converted.
hasSingleColumnChange
setSingleColumnChange
Optional. Rule to specify how a single column is converted.
$this
getMultiColumnDataTypeChange
Optional. Rule to specify how multiple columns should be converted to a different data type.
hasMultiColumnDataTypeChange
setMultiColumnDataTypeChange
Optional. Rule to specify how multiple columns should be converted to a different data type.
$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.
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.
$this
getConvertRowidColumn
Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
hasConvertRowidColumn
setConvertRowidColumn
Optional. Rule to specify how multiple tables should be converted with an additional rowid column.
$this
getSetTablePrimaryKey
Optional. Rule to specify the primary key for a table
hasSetTablePrimaryKey
setSetTablePrimaryKey
Optional. Rule to specify the primary key for a table
$this
getSinglePackageChange
Optional. Rule to specify how a single package is converted.
hasSinglePackageChange
setSinglePackageChange
Optional. Rule to specify how a single package is converted.
$this
getSourceSqlChange
Optional. Rule to change the sql code for an entity, for example, function, procedure.
hasSourceSqlChange
setSourceSqlChange
Optional. Rule to change the sql code for an entity, for example, function, procedure.
$this
getFilterTableColumns
Optional. Rule to specify the list of columns to include or exclude from a table.
hasFilterTableColumns
setFilterTableColumns
Optional. Rule to specify the list of columns to include or exclude from a table.
$this
getDetails
string
