Reference documentation and code samples for the Cloud Database Migration Service V1 API class Google::Cloud::CloudDMS::V1::DatabaseEntity.
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.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#database
def database() -> ::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) — Database.
#database=
def database=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) — Database.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) — Database.
#database_function
def database_function() -> ::Google::Cloud::CloudDMS::V1::FunctionEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::FunctionEntity) — Function.
#database_function=
def database_function=(value) -> ::Google::Cloud::CloudDMS::V1::FunctionEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::FunctionEntity) — Function.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::FunctionEntity) — Function.
#database_package
def database_package() -> ::Google::Cloud::CloudDMS::V1::PackageEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::PackageEntity) — Package.
#database_package=
def database_package=(value) -> ::Google::Cloud::CloudDMS::V1::PackageEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::PackageEntity) — Package.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::PackageEntity) — Package.
#entity_ddl
def entity_ddl() -> ::Array<::Google::Cloud::CloudDMS::V1::EntityDdl>
    Returns
    
  - (::Array<::Google::Cloud::CloudDMS::V1::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.
#entity_ddl=
def entity_ddl=(value) -> ::Array<::Google::Cloud::CloudDMS::V1::EntityDdl>
    Parameter
    
  - value (::Array<::Google::Cloud::CloudDMS::V1::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.
    Returns
    
  - (::Array<::Google::Cloud::CloudDMS::V1::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.
#entity_type
def entity_type() -> ::Google::Cloud::CloudDMS::V1::DatabaseEntityType
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::DatabaseEntityType) — The type of the database entity (table, view, index, ...).
#entity_type=
def entity_type=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseEntityType
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::DatabaseEntityType) — The type of the database entity (table, view, index, ...).
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::DatabaseEntityType) — The type of the database entity (table, view, index, ...).
#issues
def issues() -> ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>
    Returns
    
  - (::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>) — Details about the various issues found for the entity.
#issues=
def issues=(value) -> ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>
    Parameter
    
  - value (::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>) — Details about the various issues found for the entity.
    Returns
    
  - (::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>) — Details about the various issues found for the entity.
#mappings
def mappings() -> ::Array<::Google::Cloud::CloudDMS::V1::EntityMapping>
    Returns
    
  - (::Array<::Google::Cloud::CloudDMS::V1::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.
#mappings=
def mappings=(value) -> ::Array<::Google::Cloud::CloudDMS::V1::EntityMapping>
    Parameter
    
  - value (::Array<::Google::Cloud::CloudDMS::V1::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.
    Returns
    
  - (::Array<::Google::Cloud::CloudDMS::V1::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.
#materialized_view
def materialized_view() -> ::Google::Cloud::CloudDMS::V1::MaterializedViewEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) — Materialized view.
#materialized_view=
def materialized_view=(value) -> ::Google::Cloud::CloudDMS::V1::MaterializedViewEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) — Materialized view.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) — Materialized view.
#parent_entity
def parent_entity() -> ::String
    Returns
    
  - (::String) — The full name of the parent entity (e.g. schema name).
#parent_entity=
def parent_entity=(value) -> ::String
    Parameter
    
  - value (::String) — The full name of the parent entity (e.g. schema name).
    Returns
    
  - (::String) — The full name of the parent entity (e.g. schema name).
#schema
def schema() -> ::Google::Cloud::CloudDMS::V1::SchemaEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::SchemaEntity) — Schema.
#schema=
def schema=(value) -> ::Google::Cloud::CloudDMS::V1::SchemaEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::SchemaEntity) — Schema.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::SchemaEntity) — Schema.
#sequence
def sequence() -> ::Google::Cloud::CloudDMS::V1::SequenceEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::SequenceEntity) — Sequence.
#sequence=
def sequence=(value) -> ::Google::Cloud::CloudDMS::V1::SequenceEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::SequenceEntity) — Sequence.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::SequenceEntity) — Sequence.
#short_name
def short_name() -> ::String
    Returns
    
  - (::String) — The short name (e.g. table name) of the entity.
#short_name=
def short_name=(value) -> ::String
    Parameter
    
  - value (::String) — The short name (e.g. table name) of the entity.
    Returns
    
  - (::String) — The short name (e.g. table name) of the entity.
#stored_procedure
def stored_procedure() -> ::Google::Cloud::CloudDMS::V1::StoredProcedureEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) — Stored procedure.
#stored_procedure=
def stored_procedure=(value) -> ::Google::Cloud::CloudDMS::V1::StoredProcedureEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) — Stored procedure.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) — Stored procedure.
#synonym
def synonym() -> ::Google::Cloud::CloudDMS::V1::SynonymEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::SynonymEntity) — Synonym.
#synonym=
def synonym=(value) -> ::Google::Cloud::CloudDMS::V1::SynonymEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::SynonymEntity) — Synonym.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::SynonymEntity) — Synonym.
#table
def table() -> ::Google::Cloud::CloudDMS::V1::TableEntity
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::TableEntity) — Table.
#table=
def table=(value) -> ::Google::Cloud::CloudDMS::V1::TableEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::TableEntity) — Table.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::TableEntity) — Table.
#tree
def tree() -> ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType) — The type of tree the entity belongs to.
#tree=
def tree=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType) — The type of tree the entity belongs to.
    Returns
    
  - (::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType) — The type of tree the entity belongs to.
#udt
def udt() -> ::Google::Cloud::CloudDMS::V1::UDTEntity
    Returns
    
  
  #udt=
def udt=(value) -> ::Google::Cloud::CloudDMS::V1::UDTEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::UDTEntity) — UDT.
    Returns
    
  
  #view
def view() -> ::Google::Cloud::CloudDMS::V1::ViewEntity
    Returns
    
  
  #view=
def view=(value) -> ::Google::Cloud::CloudDMS::V1::ViewEntity
    Parameter
    
  - value (::Google::Cloud::CloudDMS::V1::ViewEntity) — View.
    Returns