MappingRuleOrBuilder (proto-google-cloud-dms-v1 2.38.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

MappingRule, MappingRule.Builder
```
public interface MappingRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ConditionalColumnSetValue`	`getConditionalColumnSetValue()` Optional.
`ConditionalColumnSetValueOrBuilder`	`getConditionalColumnSetValueOrBuilder()` Optional.
`ConvertRowIdToColumn`	`getConvertRowidColumn()` Optional.
`ConvertRowIdToColumnOrBuilder`	`getConvertRowidColumnOrBuilder()` Optional.
`MappingRule.DetailsCase`	`getDetailsCase()`
`String`	`getDisplayName()` Optional.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Optional.
`EntityMove`	`getEntityMove()` Optional.
`EntityMoveOrBuilder`	`getEntityMoveOrBuilder()` Optional.
`MappingRuleFilter`	`getFilter()` Required.
`MappingRuleFilterOrBuilder`	`getFilterOrBuilder()` Required.
`FilterTableColumns`	`getFilterTableColumns()` Optional.
`FilterTableColumnsOrBuilder`	`getFilterTableColumnsOrBuilder()` Optional.
`MultiColumnDatatypeChange`	`getMultiColumnDataTypeChange()` Optional.
`MultiColumnDatatypeChangeOrBuilder`	`getMultiColumnDataTypeChangeOrBuilder()` Optional.
`MultiEntityRename`	`getMultiEntityRename()` Optional.
`MultiEntityRenameOrBuilder`	`getMultiEntityRenameOrBuilder()` Optional.
`String`	`getName()` Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
`com.google.protobuf.ByteString`	`getNameBytes()` Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
`com.google.protobuf.Timestamp`	`getRevisionCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getRevisionCreateTimeOrBuilder()` Output only.
`String`	`getRevisionId()` Output only.
`com.google.protobuf.ByteString`	`getRevisionIdBytes()` Output only.
`long`	`getRuleOrder()` Required.
`DatabaseEntityType`	`getRuleScope()` Required.
`int`	`getRuleScopeValue()` Required.
`SetTablePrimaryKey`	`getSetTablePrimaryKey()` Optional.
`SetTablePrimaryKeyOrBuilder`	`getSetTablePrimaryKeyOrBuilder()` Optional.
`SingleColumnChange`	`getSingleColumnChange()` Optional.
`SingleColumnChangeOrBuilder`	`getSingleColumnChangeOrBuilder()` Optional.
`SingleEntityRename`	`getSingleEntityRename()` Optional.
`SingleEntityRenameOrBuilder`	`getSingleEntityRenameOrBuilder()` Optional.
`SinglePackageChange`	`getSinglePackageChange()` Optional.
`SinglePackageChangeOrBuilder`	`getSinglePackageChangeOrBuilder()` Optional.
`SourceSqlChange`	`getSourceSqlChange()` Optional.
`SourceSqlChangeOrBuilder`	`getSourceSqlChangeOrBuilder()` Optional.
`MappingRule.State`	`getState()` Optional.
`int`	`getStateValue()` Optional.
`boolean`	`hasConditionalColumnSetValue()` Optional.
`boolean`	`hasConvertRowidColumn()` Optional.
`boolean`	`hasEntityMove()` Optional.
`boolean`	`hasFilter()` Required.
`boolean`	`hasFilterTableColumns()` Optional.
`boolean`	`hasMultiColumnDataTypeChange()` Optional.
`boolean`	`hasMultiEntityRename()` Optional.
`boolean`	`hasRevisionCreateTime()` Output only.
`boolean`	`hasSetTablePrimaryKey()` Optional.
`boolean`	`hasSingleColumnChange()` Optional.
`boolean`	`hasSingleEntityRename()` Optional.
`boolean`	`hasSinglePackageChange()` Optional.
`boolean`	`hasSourceSqlChange()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - getName
```
String getName()
```
```
 Full name of the mapping rule resource, in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
 
```
    string name = 1;
    Returns:
    
    The name.
  - getNameBytes
```
com.google.protobuf.ByteString getNameBytes()
```
```
 Full name of the mapping rule resource, in the form of:
 projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
 
```
    string name = 1;
    Returns:
    
    The bytes for name.
  - getDisplayName
```
String getDisplayName()
```
```
 Optional. A human readable name
 
```
    string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The displayName.
  - getDisplayNameBytes
```
com.google.protobuf.ByteString getDisplayNameBytes()
```
```
 Optional. A human readable name
 
```
    string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The bytes for displayName.
  - getStateValue
```
int getStateValue()
```
```
 Optional. The mapping rule state
 
```
    .google.cloud.clouddms.v1.MappingRule.State state = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The enum numeric value on the wire for state.
  - getState
```
MappingRule.State getState()
```
```
 Optional. The mapping rule state
 
```
    .google.cloud.clouddms.v1.MappingRule.State state = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The state.
  - getRuleScopeValue
```
int getRuleScopeValue()
```
```
 Required. The rule scope
 
```
    .google.cloud.clouddms.v1.DatabaseEntityType rule_scope = 4 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The enum numeric value on the wire for ruleScope.
  - getRuleScope
```
DatabaseEntityType getRuleScope()
```
```
 Required. The rule scope
 
```
    .google.cloud.clouddms.v1.DatabaseEntityType rule_scope = 4 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The ruleScope.
  - hasFilter
```
boolean hasFilter()
```
```
 Required. The rule filter
 
```
    .google.cloud.clouddms.v1.MappingRuleFilter filter = 5 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    Whether the filter field is set.
  - getFilter
```
MappingRuleFilter getFilter()
```
```
 Required. The rule filter
 
```
    .google.cloud.clouddms.v1.MappingRuleFilter filter = 5 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The filter.
  - getFilterOrBuilder
```
MappingRuleFilterOrBuilder getFilterOrBuilder()
```
```
 Required. The rule filter
 
```
    .google.cloud.clouddms.v1.MappingRuleFilter filter = 5 [(.google.api.field_behavior) = REQUIRED];
  - getRuleOrder
```
long 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.
 
```
    int64 rule_order = 6 [(.google.api.field_behavior) = REQUIRED];
    Returns:
    
    The ruleOrder.
  - getRevisionId
```
String 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 revision_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The revisionId.
  - getRevisionIdBytes
```
com.google.protobuf.ByteString getRevisionIdBytes()
```
```
 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 revision_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The bytes for revisionId.
  - hasRevisionCreateTime
```
boolean hasRevisionCreateTime()
```
```
 Output only. The timestamp that the revision was created.
 
```
    .google.protobuf.Timestamp revision_create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    Whether the revisionCreateTime field is set.
  - getRevisionCreateTime
```
com.google.protobuf.Timestamp getRevisionCreateTime()
```
```
 Output only. The timestamp that the revision was created.
 
```
    .google.protobuf.Timestamp revision_create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
    Returns:
    
    The revisionCreateTime.
  - getRevisionCreateTimeOrBuilder
```
com.google.protobuf.TimestampOrBuilder getRevisionCreateTimeOrBuilder()
```
```
 Output only. The timestamp that the revision was created.
 
```
    .google.protobuf.Timestamp revision_create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
  - hasSingleEntityRename
```
boolean hasSingleEntityRename()
```
```
 Optional. Rule to specify how a single entity should be renamed.
 
```
    .google.cloud.clouddms.v1.SingleEntityRename single_entity_rename = 102 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the singleEntityRename field is set.
  - getSingleEntityRename
```
SingleEntityRename getSingleEntityRename()
```
```
 Optional. Rule to specify how a single entity should be renamed.
 
```
    .google.cloud.clouddms.v1.SingleEntityRename single_entity_rename = 102 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The singleEntityRename.
  - getSingleEntityRenameOrBuilder
```
SingleEntityRenameOrBuilder getSingleEntityRenameOrBuilder()
```
```
 Optional. Rule to specify how a single entity should be renamed.
 
```
    .google.cloud.clouddms.v1.SingleEntityRename single_entity_rename = 102 [(.google.api.field_behavior) = OPTIONAL];
  - hasMultiEntityRename
```
boolean hasMultiEntityRename()
```
```
 Optional. Rule to specify how multiple entities should be renamed.
 
```
    .google.cloud.clouddms.v1.MultiEntityRename multi_entity_rename = 103 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the multiEntityRename field is set.
  - getMultiEntityRename
```
MultiEntityRename getMultiEntityRename()
```
```
 Optional. Rule to specify how multiple entities should be renamed.
 
```
    .google.cloud.clouddms.v1.MultiEntityRename multi_entity_rename = 103 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The multiEntityRename.
  - getMultiEntityRenameOrBuilder
```
MultiEntityRenameOrBuilder getMultiEntityRenameOrBuilder()
```
```
 Optional. Rule to specify how multiple entities should be renamed.
 
```
    .google.cloud.clouddms.v1.MultiEntityRename multi_entity_rename = 103 [(.google.api.field_behavior) = OPTIONAL];
  - hasEntityMove
```
boolean hasEntityMove()
```
```
 Optional. Rule to specify how multiple entities should be relocated into
 a different schema.
 
```
    .google.cloud.clouddms.v1.EntityMove entity_move = 105 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the entityMove field is set.
  - getEntityMove
```
EntityMove getEntityMove()
```
```
 Optional. Rule to specify how multiple entities should be relocated into
 a different schema.
 
```
    .google.cloud.clouddms.v1.EntityMove entity_move = 105 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The entityMove.
  - getEntityMoveOrBuilder
```
EntityMoveOrBuilder getEntityMoveOrBuilder()
```
```
 Optional. Rule to specify how multiple entities should be relocated into
 a different schema.
 
```
    .google.cloud.clouddms.v1.EntityMove entity_move = 105 [(.google.api.field_behavior) = OPTIONAL];
  - hasSingleColumnChange
```
boolean hasSingleColumnChange()
```
```
 Optional. Rule to specify how a single column is converted.
 
```
    .google.cloud.clouddms.v1.SingleColumnChange single_column_change = 106 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the singleColumnChange field is set.
  - getSingleColumnChange
```
SingleColumnChange getSingleColumnChange()
```
```
 Optional. Rule to specify how a single column is converted.
 
```
    .google.cloud.clouddms.v1.SingleColumnChange single_column_change = 106 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The singleColumnChange.
  - getSingleColumnChangeOrBuilder
```
SingleColumnChangeOrBuilder getSingleColumnChangeOrBuilder()
```
```
 Optional. Rule to specify how a single column is converted.
 
```
    .google.cloud.clouddms.v1.SingleColumnChange single_column_change = 106 [(.google.api.field_behavior) = OPTIONAL];
  - hasMultiColumnDataTypeChange
```
boolean hasMultiColumnDataTypeChange()
```
```
 Optional. Rule to specify how multiple columns should be converted to a
 different data type.
 
```
    .google.cloud.clouddms.v1.MultiColumnDatatypeChange multi_column_data_type_change = 107 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the multiColumnDataTypeChange field is set.
  - getMultiColumnDataTypeChange
```
MultiColumnDatatypeChange getMultiColumnDataTypeChange()
```
```
 Optional. Rule to specify how multiple columns should be converted to a
 different data type.
 
```
    .google.cloud.clouddms.v1.MultiColumnDatatypeChange multi_column_data_type_change = 107 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The multiColumnDataTypeChange.
  - getMultiColumnDataTypeChangeOrBuilder
```
MultiColumnDatatypeChangeOrBuilder getMultiColumnDataTypeChangeOrBuilder()
```
```
 Optional. Rule to specify how multiple columns should be converted to a
 different data type.
 
```
    .google.cloud.clouddms.v1.MultiColumnDatatypeChange multi_column_data_type_change = 107 [(.google.api.field_behavior) = OPTIONAL];
  - hasConditionalColumnSetValue
```
boolean hasConditionalColumnSetValue()
```
```
 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.
 
```
    .google.cloud.clouddms.v1.ConditionalColumnSetValue conditional_column_set_value = 108 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the conditionalColumnSetValue field is set.
  - getConditionalColumnSetValue
```
ConditionalColumnSetValue 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.
 
```
    .google.cloud.clouddms.v1.ConditionalColumnSetValue conditional_column_set_value = 108 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The conditionalColumnSetValue.
  - getConditionalColumnSetValueOrBuilder
```
ConditionalColumnSetValueOrBuilder getConditionalColumnSetValueOrBuilder()
```
```
 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.
 
```
    .google.cloud.clouddms.v1.ConditionalColumnSetValue conditional_column_set_value = 108 [(.google.api.field_behavior) = OPTIONAL];
  - hasConvertRowidColumn
```
boolean hasConvertRowidColumn()
```
```
 Optional. Rule to specify how multiple tables should be converted with an
 additional rowid column.
 
```
    .google.cloud.clouddms.v1.ConvertRowIdToColumn convert_rowid_column = 114 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the convertRowidColumn field is set.
  - getConvertRowidColumn
```
ConvertRowIdToColumn getConvertRowidColumn()
```
```
 Optional. Rule to specify how multiple tables should be converted with an
 additional rowid column.
 
```
    .google.cloud.clouddms.v1.ConvertRowIdToColumn convert_rowid_column = 114 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The convertRowidColumn.
  - getConvertRowidColumnOrBuilder
```
ConvertRowIdToColumnOrBuilder getConvertRowidColumnOrBuilder()
```
```
 Optional. Rule to specify how multiple tables should be converted with an
 additional rowid column.
 
```
    .google.cloud.clouddms.v1.ConvertRowIdToColumn convert_rowid_column = 114 [(.google.api.field_behavior) = OPTIONAL];
  - hasSetTablePrimaryKey
```
boolean hasSetTablePrimaryKey()
```
```
 Optional. Rule to specify the primary key for a table
 
```
    .google.cloud.clouddms.v1.SetTablePrimaryKey set_table_primary_key = 115 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the setTablePrimaryKey field is set.
  - getSetTablePrimaryKey
```
SetTablePrimaryKey getSetTablePrimaryKey()
```
```
 Optional. Rule to specify the primary key for a table
 
```
    .google.cloud.clouddms.v1.SetTablePrimaryKey set_table_primary_key = 115 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The setTablePrimaryKey.
  - getSetTablePrimaryKeyOrBuilder
```
SetTablePrimaryKeyOrBuilder getSetTablePrimaryKeyOrBuilder()
```
```
 Optional. Rule to specify the primary key for a table
 
```
    .google.cloud.clouddms.v1.SetTablePrimaryKey set_table_primary_key = 115 [(.google.api.field_behavior) = OPTIONAL];
  - hasSinglePackageChange
```
boolean hasSinglePackageChange()
```
```
 Optional. Rule to specify how a single package is converted.
 
```
    .google.cloud.clouddms.v1.SinglePackageChange single_package_change = 116 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the singlePackageChange field is set.
  - getSinglePackageChange
```
SinglePackageChange getSinglePackageChange()
```
```
 Optional. Rule to specify how a single package is converted.
 
```
    .google.cloud.clouddms.v1.SinglePackageChange single_package_change = 116 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The singlePackageChange.
  - getSinglePackageChangeOrBuilder
```
SinglePackageChangeOrBuilder getSinglePackageChangeOrBuilder()
```
```
 Optional. Rule to specify how a single package is converted.
 
```
    .google.cloud.clouddms.v1.SinglePackageChange single_package_change = 116 [(.google.api.field_behavior) = OPTIONAL];
  - hasSourceSqlChange
```
boolean hasSourceSqlChange()
```
```
 Optional. Rule to change the sql code for an entity, for example,
 function, procedure.
 
```
    .google.cloud.clouddms.v1.SourceSqlChange source_sql_change = 117 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the sourceSqlChange field is set.
  - getSourceSqlChange
```
SourceSqlChange getSourceSqlChange()
```
```
 Optional. Rule to change the sql code for an entity, for example,
 function, procedure.
 
```
    .google.cloud.clouddms.v1.SourceSqlChange source_sql_change = 117 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The sourceSqlChange.
  - getSourceSqlChangeOrBuilder
```
SourceSqlChangeOrBuilder getSourceSqlChangeOrBuilder()
```
```
 Optional. Rule to change the sql code for an entity, for example,
 function, procedure.
 
```
    .google.cloud.clouddms.v1.SourceSqlChange source_sql_change = 117 [(.google.api.field_behavior) = OPTIONAL];
  - hasFilterTableColumns
```
boolean hasFilterTableColumns()
```
```
 Optional. Rule to specify the list of columns to include or exclude from
 a table.
 
```
    .google.cloud.clouddms.v1.FilterTableColumns filter_table_columns = 118 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the filterTableColumns field is set.
  - getFilterTableColumns
```
FilterTableColumns getFilterTableColumns()
```
```
 Optional. Rule to specify the list of columns to include or exclude from
 a table.
 
```
    .google.cloud.clouddms.v1.FilterTableColumns filter_table_columns = 118 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The filterTableColumns.
  - getFilterTableColumnsOrBuilder
```
FilterTableColumnsOrBuilder getFilterTableColumnsOrBuilder()
```
```
 Optional. Rule to specify the list of columns to include or exclude from
 a table.
 
```
    .google.cloud.clouddms.v1.FilterTableColumns filter_table_columns = 118 [(.google.api.field_behavior) = OPTIONAL];
  - getDetailsCase
```
MappingRule.DetailsCase getDetailsCase()
```

Interface MappingRuleOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

getName

getNameBytes

getDisplayName

getDisplayNameBytes

getStateValue

getState

getRuleScopeValue

getRuleScope

hasFilter

getFilter

getFilterOrBuilder

getRuleOrder

getRevisionId

getRevisionIdBytes

hasRevisionCreateTime

getRevisionCreateTime

getRevisionCreateTimeOrBuilder

hasSingleEntityRename

getSingleEntityRename

getSingleEntityRenameOrBuilder

hasMultiEntityRename

getMultiEntityRename

getMultiEntityRenameOrBuilder

hasEntityMove

getEntityMove

getEntityMoveOrBuilder

hasSingleColumnChange

getSingleColumnChange

getSingleColumnChangeOrBuilder

hasMultiColumnDataTypeChange

getMultiColumnDataTypeChange

getMultiColumnDataTypeChangeOrBuilder

hasConditionalColumnSetValue

getConditionalColumnSetValue

getConditionalColumnSetValueOrBuilder

hasConvertRowidColumn

getConvertRowidColumn

getConvertRowidColumnOrBuilder

hasSetTablePrimaryKey

getSetTablePrimaryKey

getSetTablePrimaryKeyOrBuilder

hasSinglePackageChange

getSinglePackageChange

getSinglePackageChangeOrBuilder

hasSourceSqlChange

getSourceSqlChange

getSourceSqlChangeOrBuilder

hasFilterTableColumns

getFilterTableColumns

getFilterTableColumnsOrBuilder

getDetailsCase