Class: Google::Apis::DatamigrationV1::ConstraintEntity

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

Constraint is not used as an independent entity, it is retrieved as part of another entity such as Table or View.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ConstraintEntity

Returns a new instance of ConstraintEntity.



898
899
900
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 898

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

Instance Attribute Details

#custom_features ⇒ Hash<String,Object>

Custom engine specific features. Corresponds to the JSON property customFeatures

Returns:

  • (Hash<String,Object>) 


857
858
859
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 857

def custom_features
  @custom_features
end

#name ⇒ String

The name of the table constraint. Corresponds to the JSON property name

Returns:

  • (String) 


862
863
864
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 862

def name
  @name
end

#reference_columns ⇒ Array<String>

Reference columns which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full names of referenced columns by the foreign key. Corresponds to the JSON property referenceColumns

Returns:

  • (Array<String>) 


869
870
871
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 869

def reference_columns
  @reference_columns
end

#reference_table ⇒ String

Reference table which may be associated with the constraint. For example, if the constraint is a FOREIGN_KEY, this represents the list of full name of the referenced table by the foreign key. Corresponds to the JSON property referenceTable

Returns:

  • (String) 


876
877
878
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 876

def reference_table
  @reference_table
end

#table_columns ⇒ Array<String>

Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key. Corresponds to the JSON property tableColumns

Returns:

  • (Array<String>) 


882
883
884
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 882

def table_columns
  @table_columns
end

#table_name ⇒ String

Table which is associated with the constraint. In case the constraint is defined on a table, this field is left empty as this information is stored in parent_name. However, if constraint is defined on a view, this field stores the table name on which the view is defined. Corresponds to the JSON property tableName

Returns:

  • (String) 


890
891
892
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 890

def table_name
  @table_name
end

#type ⇒ String

Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported). Corresponds to the JSON property type

Returns:

  • (String) 


896
897
898
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 896

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



903
904
905
906
907
908
909
910
911
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 903

def update!(**args)
  @custom_features = args[:custom_features] if args.key?(:custom_features)
  @name = args[:name] if args.key?(:name)
  @reference_columns = args[:reference_columns] if args.key?(:reference_columns)
  @reference_table = args[:reference_table] if args.key?(:reference_table)
  @table_columns = args[:table_columns] if args.key?(:table_columns)
  @table_name = args[:table_name] if args.key?(:table_name)
  @type = args[:type] if args.key?(:type)
end