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.



1169
1170
1171
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1169

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

Instance Attribute Details

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

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

Returns:



1100
1101
1102
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1100

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:



1105
1106
1107
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1105

def database_package
  @database_package
end

#entity_type ⇒ String

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

Returns:

  • (String) 


1110
1111
1112
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1110

def entity_type
  @entity_type
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:



1118
1119
1120
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1118

def mappings
  @mappings
end

#parent_entity ⇒ String

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

Returns:

  • (String) 


1123
1124
1125
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1123

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:



1132
1133
1134
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1132

def schema
  @schema
end

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

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

Returns:



1137
1138
1139
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1137

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) 


1142
1143
1144
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1142

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:



1147
1148
1149
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1147

def stored_procedure
  @stored_procedure
end

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

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

Returns:



1152
1153
1154
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1152

def synonym
  @synonym
end

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

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

Returns:



1157
1158
1159
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1157

def table
  @table
end

#tree ⇒ String

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

Returns:

  • (String) 


1162
1163
1164
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1162

def tree
  @tree
end

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

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

Returns:



1167
1168
1169
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1167

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
 
# File 'lib/google/apis/datamigration_v1/classes.rb', line 1174

def update!(**args)
  @database_function = args[:database_function] if args.key?(:database_function)
  @database_package = args[:database_package] if args.key?(:database_package)
  @entity_type = args[:entity_type] if args.key?(:entity_type)
  @mappings = args[:mappings] if args.key?(:mappings)
  @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)
  @view = args[:view] if args.key?(:view)
end