Class: Google::Apis::DatamigrationV1::DatabaseEntity

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

The base entity type for all the database related entities. The message contains the entity name, the name of its parent, the entity type, and the specific details per entity type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DatabaseEntity

Returns a new instance of DatabaseEntity.



1393
1394
1395
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1393

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#database ⇒ Google::Apis::DatamigrationV1::DatabaseInstanceEntity

DatabaseInstance acts as a parent entity to other database entities. Corresponds to the JSON property database

Returns:



1297
1298
1299
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1297

def database
  @database
end

#database_function ⇒ Google::Apis::DatamigrationV1::FunctionEntity

Function's parent is a schema. Corresponds to the JSON property databaseFunction

Returns:



1302
1303
1304
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1302

def database_function
  @database_function
end

#database_package ⇒ Google::Apis::DatamigrationV1::PackageEntity

Package's parent is a schema. Corresponds to the JSON property databasePackage

Returns:



1307
1308
1309
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1307

def database_package
  @database_package
end

#entity_ddl ⇒ Array<Google::Apis::DatamigrationV1::EntityDdl>

Details about the entity DDL script. Multiple DDL scripts are provided for child entities such as a table entity will have one DDL for the table with additional DDLs for each index, constraint and such. Corresponds to the JSON property entityDdl

Returns:



1314
1315
1316
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1314

def entity_ddl
  @entity_ddl
end

#entity_type ⇒ String

The type of the database entity (table, view, index, ...). Corresponds to the JSON property entityType

Returns:

  • (String) 


1319
1320
1321
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1319

def entity_type
  @entity_type
end

#issues ⇒ Array<Google::Apis::DatamigrationV1::EntityIssue>

Details about the various issues found for the entity. Corresponds to the JSON property issues

Returns:



1324
1325
1326
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1324

def issues
  @issues
end

#mappings ⇒ Array<Google::Apis::DatamigrationV1::EntityMapping>

Details about entity mappings. For source tree entities, this holds the draft entities which were generated by the mapping rules. For draft tree entities, this holds the source entities which were converted to form the draft entity. Destination entities will have no mapping details. Corresponds to the JSON property mappings

Returns:



1332
1333
1334
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1332

def mappings
  @mappings
end

#materialized_view ⇒ Google::Apis::DatamigrationV1::MaterializedViewEntity

MaterializedView's parent is a schema. Corresponds to the JSON property materializedView

Returns:



1337
1338
1339
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1337

def materialized_view
  @materialized_view
end

#parent_entity ⇒ String

The full name of the parent entity (e.g. schema name). Corresponds to the JSON property parentEntity

Returns:

  • (String) 


1342
1343
1344
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1342

def parent_entity
  @parent_entity
end

#schema ⇒ Google::Apis::DatamigrationV1::SchemaEntity

Schema typically has no parent entity, but can have a parent entity DatabaseInstance (for database engines which support it). For some database engines, the terms schema and user can be used interchangeably when they refer to a namespace or a collection of other database entities. Can store additional information which is schema specific. Corresponds to the JSON property schema

Returns:



1351
1352
1353
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1351

def schema
  @schema
end

#sequence ⇒ Google::Apis::DatamigrationV1::SequenceEntity

Sequence's parent is a schema. Corresponds to the JSON property sequence

Returns:



1356
1357
1358
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1356

def sequence
  @sequence
end

#short_name ⇒ String

The short name (e.g. table name) of the entity. Corresponds to the JSON property shortName

Returns:

  • (String) 


1361
1362
1363
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1361

def short_name
  @short_name
end

#stored_procedure ⇒ Google::Apis::DatamigrationV1::StoredProcedureEntity

Stored procedure's parent is a schema. Corresponds to the JSON property storedProcedure

Returns:



1366
1367
1368
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1366

def stored_procedure
  @stored_procedure
end

#synonym ⇒ Google::Apis::DatamigrationV1::SynonymEntity

Synonym's parent is a schema. Corresponds to the JSON property synonym

Returns:



1371
1372
1373
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1371

def synonym
  @synonym
end

#table ⇒ Google::Apis::DatamigrationV1::TableEntity

Table's parent is a schema. Corresponds to the JSON property table

Returns:



1376
1377
1378
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1376

def table
  @table
end

#tree ⇒ String

The type of tree the entity belongs to. Corresponds to the JSON property tree

Returns:

  • (String) 


1381
1382
1383
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1381

def tree
  @tree
end

#udt ⇒ Google::Apis::DatamigrationV1::UdtEntity

UDT's parent is a schema. Corresponds to the JSON property udt

Returns:



1386
1387
1388
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1386

def udt
  @udt
end

#view ⇒ Google::Apis::DatamigrationV1::ViewEntity

View's parent is a schema. Corresponds to the JSON property view

Returns:



1391
1392
1393
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1391

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1398

def update!(**args)
  @database = args[:database] if args.key?(:database)
  @database_function = args[:database_function] if args.key?(:database_function)
  @database_package = args[:database_package] if args.key?(:database_package)
  @entity_ddl = args[:entity_ddl] if args.key?(:entity_ddl)
  @entity_type = args[:entity_type] if args.key?(:entity_type)
  @issues = args[:issues] if args.key?(:issues)
  @mappings = args[:mappings] if args.key?(:mappings)
  @materialized_view = args[:materialized_view] if args.key?(:materialized_view)
  @parent_entity = args[:parent_entity] if args.key?(:parent_entity)
  @schema = args[:schema] if args.key?(:schema)
  @sequence = args[:sequence] if args.key?(:sequence)
  @short_name = args[:short_name] if args.key?(:short_name)
  @stored_procedure = args[:stored_procedure] if args.key?(:stored_procedure)
  @synonym = args[:synonym] if args.key?(:synonym)
  @table = args[:table] if args.key?(:table)
  @tree = args[:tree] if args.key?(:tree)
  @udt = args[:udt] if args.key?(:udt)
  @view = args[:view] if args.key?(:view)
end