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.



2282
2283
2284
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2282

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


2249
2250
2251
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2249

def custom_features
  @custom_features
end

#name ⇒ String

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

Returns:

  • (String) 


2254
2255
2256
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2254

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


2260
2261
2262
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2260

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


2269
2270
2271
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2269

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) 


2274
2275
2276
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2274

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) 


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

def unique
  @unique
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 2287

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