Interface MappingRuleOrBuilder (2.42.0)

public interface MappingRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConditionalColumnSetValue()

public abstract 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
Type Description
ConditionalColumnSetValue

The conditionalColumnSetValue.

getConditionalColumnSetValueOrBuilder()

public abstract 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];

Returns
Type Description
ConditionalColumnSetValueOrBuilder

getConvertRowidColumn()

public abstract 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
Type Description
ConvertRowIdToColumn

The convertRowidColumn.

getConvertRowidColumnOrBuilder()

public abstract 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];

Returns
Type Description
ConvertRowIdToColumnOrBuilder

getDetailsCase()

public abstract MappingRule.DetailsCase getDetailsCase()
Returns
Type Description
MappingRule.DetailsCase

getDisplayName()

public abstract String getDisplayName()

Optional. A human readable name

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Optional. A human readable name

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEntityMove()

public abstract 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
Type Description
EntityMove

The entityMove.

getEntityMoveOrBuilder()

public abstract 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];

Returns
Type Description
EntityMoveOrBuilder

getFilter()

public abstract MappingRuleFilter getFilter()

Required. The rule filter

.google.cloud.clouddms.v1.MappingRuleFilter filter = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MappingRuleFilter

The filter.

getFilterOrBuilder()

public abstract MappingRuleFilterOrBuilder getFilterOrBuilder()

Required. The rule filter

.google.cloud.clouddms.v1.MappingRuleFilter filter = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
MappingRuleFilterOrBuilder

getFilterTableColumns()

public abstract 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
Type Description
FilterTableColumns

The filterTableColumns.

getFilterTableColumnsOrBuilder()

public abstract 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];

Returns
Type Description
FilterTableColumnsOrBuilder

getMultiColumnDataTypeChange()

public abstract 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
Type Description
MultiColumnDatatypeChange

The multiColumnDataTypeChange.

getMultiColumnDataTypeChangeOrBuilder()

public abstract 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];

Returns
Type Description
MultiColumnDatatypeChangeOrBuilder

getMultiEntityRename()

public abstract 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
Type Description
MultiEntityRename

The multiEntityRename.

getMultiEntityRenameOrBuilder()

public abstract 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];

Returns
Type Description
MultiEntityRenameOrBuilder

getName()

public abstract 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
Type Description
String

The name.

getNameBytes()

public abstract 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
Type Description
ByteString

The bytes for name.

getRevisionCreateTime()

public abstract 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
Type Description
Timestamp

The revisionCreateTime.

getRevisionCreateTimeOrBuilder()

public abstract TimestampOrBuilder getRevisionCreateTimeOrBuilder()

Output only. The timestamp that the revision was created.

.google.protobuf.Timestamp revision_create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getRevisionId()

public abstract 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
Type Description
String

The revisionId.

getRevisionIdBytes()

public abstract 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
Type Description
ByteString

The bytes for revisionId.

getRuleOrder()

public abstract 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
Type Description
long

The ruleOrder.

getRuleScope()

public abstract DatabaseEntityType getRuleScope()

Required. The rule scope

.google.cloud.clouddms.v1.DatabaseEntityType rule_scope = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatabaseEntityType

The ruleScope.

getRuleScopeValue()

public abstract int getRuleScopeValue()

Required. The rule scope

.google.cloud.clouddms.v1.DatabaseEntityType rule_scope = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for ruleScope.

getSetTablePrimaryKey()

public abstract 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
Type Description
SetTablePrimaryKey

The setTablePrimaryKey.

getSetTablePrimaryKeyOrBuilder()

public abstract 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];

Returns
Type Description
SetTablePrimaryKeyOrBuilder

getSingleColumnChange()

public abstract 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
Type Description
SingleColumnChange

The singleColumnChange.

getSingleColumnChangeOrBuilder()

public abstract 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];

Returns
Type Description
SingleColumnChangeOrBuilder

getSingleEntityRename()

public abstract 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
Type Description
SingleEntityRename

The singleEntityRename.

getSingleEntityRenameOrBuilder()

public abstract 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];

Returns
Type Description
SingleEntityRenameOrBuilder

getSinglePackageChange()

public abstract 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
Type Description
SinglePackageChange

The singlePackageChange.

getSinglePackageChangeOrBuilder()

public abstract 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];

Returns
Type Description
SinglePackageChangeOrBuilder

getSourceSqlChange()

public abstract 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
Type Description
SourceSqlChange

The sourceSqlChange.

getSourceSqlChangeOrBuilder()

public abstract 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];

Returns
Type Description
SourceSqlChangeOrBuilder

getState()

public abstract MappingRule.State getState()

Optional. The mapping rule state

.google.cloud.clouddms.v1.MappingRule.State state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MappingRule.State

The state.

getStateValue()

public abstract int getStateValue()

Optional. The mapping rule state

.google.cloud.clouddms.v1.MappingRule.State state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasConditionalColumnSetValue()

public abstract 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
Type Description
boolean

Whether the conditionalColumnSetValue field is set.

hasConvertRowidColumn()

public abstract 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
Type Description
boolean

Whether the convertRowidColumn field is set.

hasEntityMove()

public abstract 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
Type Description
boolean

Whether the entityMove field is set.

hasFilter()

public abstract boolean hasFilter()

Required. The rule filter

.google.cloud.clouddms.v1.MappingRuleFilter filter = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the filter field is set.

hasFilterTableColumns()

public abstract 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
Type Description
boolean

Whether the filterTableColumns field is set.

hasMultiColumnDataTypeChange()

public abstract 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
Type Description
boolean

Whether the multiColumnDataTypeChange field is set.

hasMultiEntityRename()

public abstract 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
Type Description
boolean

Whether the multiEntityRename field is set.

hasRevisionCreateTime()

public abstract 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
Type Description
boolean

Whether the revisionCreateTime field is set.

hasSetTablePrimaryKey()

public abstract 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
Type Description
boolean

Whether the setTablePrimaryKey field is set.

hasSingleColumnChange()

public abstract 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
Type Description
boolean

Whether the singleColumnChange field is set.

hasSingleEntityRename()

public abstract 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
Type Description
boolean

Whether the singleEntityRename field is set.

hasSinglePackageChange()

public abstract 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
Type Description
boolean

Whether the singlePackageChange field is set.

hasSourceSqlChange()

public abstract 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
Type Description
boolean

Whether the sourceSqlChange field is set.