Class: Google::Cloud::CloudDMS::V1::MappingRule

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb

Overview

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.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#conditional_column_set_value ⇒ ::Google::Cloud::CloudDMS::V1::ConditionalColumnSetValue

Returns 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:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#convert_rowid_column ⇒ ::Google::Cloud::CloudDMS::V1::ConvertRowIdToColumn

Returns Optional. Rule to specify how multiple tables should be converted with an additional rowid column.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#display_name ⇒ ::String

Returns Optional. A human readable name.

Returns:

  • (::String) —

    Optional. A human readable name



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#entity_move ⇒ ::Google::Cloud::CloudDMS::V1::EntityMove

Returns Optional. Rule to specify how multiple entities should be relocated into a different schema.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#filter ⇒ ::Google::Cloud::CloudDMS::V1::MappingRuleFilter

Returns Required. The rule filter.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#filter_table_columns ⇒ ::Google::Cloud::CloudDMS::V1::FilterTableColumns

Returns Optional. Rule to specify the list of columns to include or exclude from a table.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#multi_column_data_type_change ⇒ ::Google::Cloud::CloudDMS::V1::MultiColumnDatatypeChange

Returns Optional. Rule to specify how multiple columns should be converted to a different data type.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#multi_entity_rename ⇒ ::Google::Cloud::CloudDMS::V1::MultiEntityRename

Returns Optional. Rule to specify how multiple entities should be renamed.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#name ⇒ ::String

Returns Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.

Returns:

  • (::String) —

    Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#revision_create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp that the revision was created.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#revision_id ⇒ ::String (readonly)

Returns 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:

  • (::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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#rule_order ⇒ ::Integer

Returns 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:

  • (::Integer) —

    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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#rule_scope ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntityType

Returns Required. The rule scope.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#set_table_primary_key ⇒ ::Google::Cloud::CloudDMS::V1::SetTablePrimaryKey

Returns Optional. Rule to specify the primary key for a table.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#single_column_change ⇒ ::Google::Cloud::CloudDMS::V1::SingleColumnChange

Returns Optional. Rule to specify how a single column is converted.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#single_entity_rename ⇒ ::Google::Cloud::CloudDMS::V1::SingleEntityRename

Returns Optional. Rule to specify how a single entity should be renamed.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#single_package_change ⇒ ::Google::Cloud::CloudDMS::V1::SinglePackageChange

Returns Optional. Rule to specify how a single package is converted.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#source_sql_change ⇒ ::Google::Cloud::CloudDMS::V1::SourceSqlChange

Returns Optional. Rule to change the sql code for an entity, for example, function, procedure.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end

#state ⇒ ::Google::Cloud::CloudDMS::V1::MappingRule::State

Returns Optional. The mapping rule state.

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 287

class MappingRule
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The current mapping rule state such as enabled, disabled or deleted.
  module State
    # The state of the mapping rule is unknown.
    STATE_UNSPECIFIED = 0

    # The rule is enabled.
    ENABLED = 1

    # The rule is disabled.
    DISABLED = 2

    # The rule is logically deleted.
    DELETED = 3
  end
end