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.



2313
2314
2315
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2313

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


2280
2281
2282
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2280

def custom_features
  @custom_features
end

#name ⇒ String

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

Returns:

  • (String) 


2285
2286
2287
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2285

def name
  @name
end

#table_columns ⇒ Array<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>) 


2291
2292
2293
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2291

def table_columns
  @table_columns
end

#table_columns_descending ⇒ Array<Boolean>

For each table_column, mark whether it's sorting order is ascending (false) or descending (true). If no value is defined, assume all columns are sorted in ascending order. Otherwise, the number of items must match that of table_columns with each value specifying the direction of the matched column by its index. Corresponds to the JSON property tableColumnsDescending

Returns:

  • (Array<Boolean>) 


2300
2301
2302
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2300

def table_columns_descending
  @table_columns_descending
end

#type ⇒ String

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

Returns:

  • (String) 


2305
2306
2307
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2305

def type
  @type
end

#unique ⇒ Boolean Also known as: unique?

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

Returns:

  • (Boolean) 


2310
2311
2312
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2310

def unique
  @unique
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2318

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)
  @table_columns_descending = args[:table_columns_descending] if args.key?(:table_columns_descending)
  @type = args[:type] if args.key?(:type)
  @unique = args[:unique] if args.key?(:unique)
end