Cloud Database Migration Service V1 API - Class Google::Cloud::CloudDMS::V1::DatabaseEntity (v1.2.0)

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.

    Note: The following fields are mutually exclusive: database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database=

def database=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) — Database.

    Note: The following fields are mutually exclusive: database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) — Database.

    Note: The following fields are mutually exclusive: database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database_function

def database_function() -> ::Google::Cloud::CloudDMS::V1::FunctionEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::FunctionEntity) — Function.

    Note: The following fields are mutually exclusive: database_function, database, schema, table, view, sequence, stored_procedure, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database_function=

def database_function=(value) -> ::Google::Cloud::CloudDMS::V1::FunctionEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::FunctionEntity) — Function.

    Note: The following fields are mutually exclusive: database_function, database, schema, table, view, sequence, stored_procedure, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::FunctionEntity) — Function.

    Note: The following fields are mutually exclusive: database_function, database, schema, table, view, sequence, stored_procedure, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database_package

def database_package() -> ::Google::Cloud::CloudDMS::V1::PackageEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::PackageEntity) — Package.

    Note: The following fields are mutually exclusive: database_package, database, schema, table, view, sequence, stored_procedure, database_function, synonym, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database_package=

def database_package=(value) -> ::Google::Cloud::CloudDMS::V1::PackageEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::PackageEntity) — Package.

    Note: The following fields are mutually exclusive: database_package, database, schema, table, view, sequence, stored_procedure, database_function, synonym, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::PackageEntity) — Package.

    Note: The following fields are mutually exclusive: database_package, database, schema, table, view, sequence, stored_procedure, database_function, synonym, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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

#entity_type=

def entity_type=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseEntityType
Parameter
Returns

#issues

def issues() -> ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>
Returns

#issues=

def issues=(value) -> ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>
Parameter
Returns

#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.

    Note: The following fields are mutually exclusive: materialized_view, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt. If a field in that set is populated, all other fields in the set will automatically be cleared.

#materialized_view=

def materialized_view=(value) -> ::Google::Cloud::CloudDMS::V1::MaterializedViewEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) — Materialized view.

    Note: The following fields are mutually exclusive: materialized_view, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) — Materialized view.

    Note: The following fields are mutually exclusive: materialized_view, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

    Note: The following fields are mutually exclusive: schema, database, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#schema=

def schema=(value) -> ::Google::Cloud::CloudDMS::V1::SchemaEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::SchemaEntity) — Schema.

    Note: The following fields are mutually exclusive: schema, database, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::SchemaEntity) — Schema.

    Note: The following fields are mutually exclusive: schema, database, table, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sequence

def sequence() -> ::Google::Cloud::CloudDMS::V1::SequenceEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::SequenceEntity) — Sequence.

    Note: The following fields are mutually exclusive: sequence, database, schema, table, view, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sequence=

def sequence=(value) -> ::Google::Cloud::CloudDMS::V1::SequenceEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::SequenceEntity) — Sequence.

    Note: The following fields are mutually exclusive: sequence, database, schema, table, view, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::SequenceEntity) — Sequence.

    Note: The following fields are mutually exclusive: sequence, database, schema, table, view, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#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.

    Note: The following fields are mutually exclusive: stored_procedure, database, schema, table, view, sequence, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#stored_procedure=

def stored_procedure=(value) -> ::Google::Cloud::CloudDMS::V1::StoredProcedureEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) — Stored procedure.

    Note: The following fields are mutually exclusive: stored_procedure, database, schema, table, view, sequence, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) — Stored procedure.

    Note: The following fields are mutually exclusive: stored_procedure, database, schema, table, view, sequence, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#synonym

def synonym() -> ::Google::Cloud::CloudDMS::V1::SynonymEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::SynonymEntity) — Synonym.

    Note: The following fields are mutually exclusive: synonym, database, schema, table, view, sequence, stored_procedure, database_function, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#synonym=

def synonym=(value) -> ::Google::Cloud::CloudDMS::V1::SynonymEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::SynonymEntity) — Synonym.

    Note: The following fields are mutually exclusive: synonym, database, schema, table, view, sequence, stored_procedure, database_function, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::SynonymEntity) — Synonym.

    Note: The following fields are mutually exclusive: synonym, database, schema, table, view, sequence, stored_procedure, database_function, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#table

def table() -> ::Google::Cloud::CloudDMS::V1::TableEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::TableEntity) — Table.

    Note: The following fields are mutually exclusive: table, database, schema, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#table=

def table=(value) -> ::Google::Cloud::CloudDMS::V1::TableEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::TableEntity) — Table.

    Note: The following fields are mutually exclusive: table, database, schema, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::TableEntity) — Table.

    Note: The following fields are mutually exclusive: table, database, schema, view, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#tree

def tree() -> ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType
Returns

#tree=

def tree=(value) -> ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType
Parameter
Returns

#udt

def udt() -> ::Google::Cloud::CloudDMS::V1::UDTEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::UDTEntity) — UDT.

    Note: The following fields are mutually exclusive: udt, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#udt=

def udt=(value) -> ::Google::Cloud::CloudDMS::V1::UDTEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::UDTEntity) — UDT.

    Note: The following fields are mutually exclusive: udt, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::UDTEntity) — UDT.

    Note: The following fields are mutually exclusive: udt, database, schema, table, view, sequence, stored_procedure, database_function, synonym, database_package, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#view

def view() -> ::Google::Cloud::CloudDMS::V1::ViewEntity
Returns
  • (::Google::Cloud::CloudDMS::V1::ViewEntity) — View.

    Note: The following fields are mutually exclusive: view, database, schema, table, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

#view=

def view=(value) -> ::Google::Cloud::CloudDMS::V1::ViewEntity
Parameter
  • value (::Google::Cloud::CloudDMS::V1::ViewEntity) — View.

    Note: The following fields are mutually exclusive: view, database, schema, table, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::CloudDMS::V1::ViewEntity) — View.

    Note: The following fields are mutually exclusive: view, database, schema, table, sequence, stored_procedure, database_function, synonym, database_package, udt, materialized_view. If a field in that set is populated, all other fields in the set will automatically be cleared.