Class: Google::Apis::DatamigrationV1::MappingRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datamigration_v1/classes.rb,
lib/google/apis/datamigration_v1/representations.rb,
lib/google/apis/datamigration_v1/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MappingRule

Returns a new instance of MappingRule.



2898
2899
2900
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2898

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#conditional_column_set_value ⇒ Google::Apis::DatamigrationV1::ConditionalColumnSetValue

Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. Corresponds to the JSON property conditionalColumnSetValue

Returns:



2766
2767
2768
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2766

def conditional_column_set_value
  @conditional_column_set_value
end

#convert_rowid_column ⇒ Google::Apis::DatamigrationV1::ConvertRowIdToColumn

Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. Corresponds to the JSON property convertRowidColumn

Returns:



2776
2777
2778
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2776

def convert_rowid_column
  @convert_rowid_column
end

#display_name ⇒ String

Optional. A human readable name Corresponds to the JSON property displayName

Returns:

  • (String) 


2781
2782
2783
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2781

def display_name
  @display_name
end

#entity_move ⇒ Google::Apis::DatamigrationV1::EntityMove

Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT Corresponds to the JSON property entityMove

Returns:



2789
2790
2791
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2789

def entity_move
  @entity_move
end

#filter ⇒ Google::Apis::DatamigrationV1::MappingRuleFilter

A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. Corresponds to the JSON property filter

Returns:



2796
2797
2798
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2796

def filter
  @filter
end

#filter_table_columns ⇒ Google::Apis::DatamigrationV1::FilterTableColumns

Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. Corresponds to the JSON property filterTableColumns

Returns:



2804
2805
2806
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2804

def filter_table_columns
  @filter_table_columns
end

#multi_column_data_type_change ⇒ Google::Apis::DatamigrationV1::MultiColumnDatatypeChange

Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). Corresponds to the JSON property multiColumnDataTypeChange

Returns:



2816
2817
2818
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2816

def multi_column_data_type_change
  @multi_column_data_type_change
end

#multi_entity_rename ⇒ Google::Apis::DatamigrationV1::MultiEntityRename

Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT Corresponds to the JSON property multiEntityRename

Returns:



2824
2825
2826
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2824

def multi_entity_rename
  @multi_entity_rename
end

#name ⇒ String

Full name of the mapping rule resource, in the form of: projects/project/ locations/location/conversionWorkspaces/set/mappingRule/rule. Corresponds to the JSON property name

Returns:

  • (String) 


2830
2831
2832
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2830

def name
  @name
end

#revision_create_time ⇒ String

Output only. The timestamp that the revision was created. Corresponds to the JSON property revisionCreateTime

Returns:

  • (String) 


2835
2836
2837
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2835

def revision_create_time
  @revision_create_time
end

#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. Corresponds to the JSON property revisionId

Returns:

  • (String) 


2842
2843
2844
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2842

def revision_id
  @revision_id
end

#rule_order ⇒ Fixnum

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. Corresponds to the JSON property ruleOrder

Returns:

  • (Fixnum) 


2848
2849
2850
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2848

def rule_order
  @rule_order
end

#rule_scope ⇒ String

Required. The rule scope Corresponds to the JSON property ruleScope

Returns:

  • (String) 


2853
2854
2855
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2853

def rule_scope
  @rule_scope
end

#set_table_primary_key ⇒ Google::Apis::DatamigrationV1::SetTablePrimaryKey

Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. Corresponds to the JSON property setTablePrimaryKey

Returns:



2860
2861
2862
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2860

def set_table_primary_key
  @set_table_primary_key
end

#single_column_change ⇒ Google::Apis::DatamigrationV1::SingleColumnChange

Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. Corresponds to the JSON property singleColumnChange

Returns:



2869
2870
2871
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2869

def single_column_change
  @single_column_change
end

#single_entity_rename ⇒ Google::Apis::DatamigrationV1::SingleEntityRename

Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym Corresponds to the JSON property singleEntityRename

Returns:



2877
2878
2879
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2877

def single_entity_rename
  @single_entity_rename
end

#single_package_change ⇒ Google::Apis::DatamigrationV1::SinglePackageChange

Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package Corresponds to the JSON property singlePackageChange

Returns:



2884
2885
2886
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2884

def single_package_change
  @single_package_change
end

#source_sql_change ⇒ Google::Apis::DatamigrationV1::SourceSqlChange

Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View Corresponds to the JSON property sourceSqlChange

Returns:



2891
2892
2893
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2891

def source_sql_change
  @source_sql_change
end

#state ⇒ String

Optional. The mapping rule state Corresponds to the JSON property state

Returns:

  • (String) 


2896
2897
2898
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2896

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2903

def update!(**args)
  @conditional_column_set_value = args[:conditional_column_set_value] if args.key?(:conditional_column_set_value)
  @convert_rowid_column = args[:convert_rowid_column] if args.key?(:convert_rowid_column)
  @display_name = args[:display_name] if args.key?(:display_name)
  @entity_move = args[:entity_move] if args.key?(:entity_move)
  @filter = args[:filter] if args.key?(:filter)
  @filter_table_columns = args[:filter_table_columns] if args.key?(:filter_table_columns)
  @multi_column_data_type_change = args[:multi_column_data_type_change] if args.key?(:multi_column_data_type_change)
  @multi_entity_rename = args[:multi_entity_rename] if args.key?(:multi_entity_rename)
  @name = args[:name] if args.key?(:name)
  @revision_create_time = args[:revision_create_time] if args.key?(:revision_create_time)
  @revision_id = args[:revision_id] if args.key?(:revision_id)
  @rule_order = args[:rule_order] if args.key?(:rule_order)
  @rule_scope = args[:rule_scope] if args.key?(:rule_scope)
  @set_table_primary_key = args[:set_table_primary_key] if args.key?(:set_table_primary_key)
  @single_column_change = args[:single_column_change] if args.key?(:single_column_change)
  @single_entity_rename = args[:single_entity_rename] if args.key?(:single_entity_rename)
  @single_package_change = args[:single_package_change] if args.key?(:single_package_change)
  @source_sql_change = args[:source_sql_change] if args.key?(:source_sql_change)
  @state = args[:state] if args.key?(:state)
end