Class: Google::Apis::DatamigrationV1::IndexEntity

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

Index is not used as an independent entity, it is retrieved as part of a Table entity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ IndexEntity

Returns a new instance of IndexEntity.



1739
1740
1741
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1739

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


1715
1716
1717
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1715

def custom_features
  @custom_features
end

#nameString

The name of the index. Corresponds to the JSON property name

Returns:

  • (String)


1720
1721
1722
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1720

def name
  @name
end

#table_columnsArray<String>

Table columns used as part of the Index, for example B-TREE index should list the columns which constitutes the index. Corresponds to the JSON property tableColumns

Returns:

  • (Array<String>)


1726
1727
1728
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1726

def table_columns
  @table_columns
end

#typeString

Type of index, for example B-TREE. Corresponds to the JSON property type

Returns:

  • (String)


1731
1732
1733
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1731

def type
  @type
end

#uniqueBoolean Also known as: unique?

Boolean value indicating whether the index is unique. Corresponds to the JSON property unique

Returns:

  • (Boolean)


1736
1737
1738
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1736

def unique
  @unique
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1744
1745
1746
1747
1748
1749
1750
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1744

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