Cloud Database Migration Service V1 API - Class Google::Cloud::CloudDMS::V1::ConstraintEntity (v0.6.0)

Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::ConstraintEntity.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#custom_features

def custom_features() -> ::Google::Protobuf::Struct
Returns

#custom_features=

def custom_features=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The name of the table constraint.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name of the table constraint.
Returns
  • (::String) — The name of the table constraint.

#reference_columns

def reference_columns() -> ::Array<::String>
Returns
  • (::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.

#reference_columns=

def reference_columns=(value) -> ::Array<::String>
Parameter
  • value (::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.
Returns
  • (::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.

#reference_table

def reference_table() -> ::String
Returns
  • (::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.

#reference_table=

def reference_table=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#table_columns

def table_columns() -> ::Array<::String>
Returns
  • (::Array<::String>) — Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key.

#table_columns=

def table_columns=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key.
Returns
  • (::Array<::String>) — Table columns used as part of the Constraint, for example primary key constraint should list the columns which constitutes the key.

#table_name

def table_name() -> ::String
Returns
  • (::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.

#table_name=

def table_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#type

def type() -> ::String
Returns
  • (::String) — Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported).

#type=

def type=(value) -> ::String
Parameter
  • value (::String) — Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported).
Returns
  • (::String) — Type of constraint, for example unique, primary key, foreign key (currently only primary key is supported).