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.



996
997
998
# File 'lib/google/apis/datamigration_v1/classes.rb', line 996

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

Instance Attribute Details

#custom_featuresHash<String,Object>

Custom engine specific features. Corresponds to the JSON property customFeatures

Returns:

  • (Hash<String,Object>)


955
956
957
# File 'lib/google/apis/datamigration_v1/classes.rb', line 955

def custom_features
  @custom_features
end

#nameString

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

Returns:

  • (String)


960
961
962
# File 'lib/google/apis/datamigration_v1/classes.rb', line 960

def name
  @name
end

#reference_columnsArray<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>)


967
968
969
# File 'lib/google/apis/datamigration_v1/classes.rb', line 967

def reference_columns
  @reference_columns
end

#reference_tableString

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)


974
975
976
# File 'lib/google/apis/datamigration_v1/classes.rb', line 974

def reference_table
  @reference_table
end

#table_columnsArray<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>)


980
981
982
# File 'lib/google/apis/datamigration_v1/classes.rb', line 980

def table_columns
  @table_columns
end

#table_nameString

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)


988
989
990
# File 'lib/google/apis/datamigration_v1/classes.rb', line 988

def table_name
  @table_name
end

#typeString

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

Returns:

  • (String)


994
995
996
# File 'lib/google/apis/datamigration_v1/classes.rb', line 994

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1001
1002
1003
1004
1005
1006
1007
1008
1009
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1001

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