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.



1800
1801
1802
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1800

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


1776
1777
1778
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1776

def custom_features
  @custom_features
end

#nameString

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

Returns:

  • (String)


1781
1782
1783
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1781

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


1787
1788
1789
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1787

def table_columns
  @table_columns
end

#typeString

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

Returns:

  • (String)


1792
1793
1794
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1792

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)


1797
1798
1799
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1797

def unique
  @unique
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1805
1806
1807
1808
1809
1810
1811
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1805

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