Class: Google::Cloud::CloudDMS::V1::DatabaseEntity

Inherits:

Object

• Object
• Google::Cloud::CloudDMS::V1::DatabaseEntity

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.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.

Defined Under Namespace

Modules: TreeType

Instance Attribute Summary

• #database ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity

  Database.

• #database_function ⇒ ::Google::Cloud::CloudDMS::V1::FunctionEntity

  Function.

• #database_package ⇒ ::Google::Cloud::CloudDMS::V1::PackageEntity

  Package.

• #entity_ddl ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityDdl>

  Details about the entity DDL script.

• #entity_type ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntityType

  The type of the database entity (table, view, index, ...).

• #issues ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>

  Details about the various issues found for the entity.

• #mappings ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityMapping>

  Details about entity mappings.

• #materialized_view ⇒ ::Google::Cloud::CloudDMS::V1::MaterializedViewEntity

  Materialized view.

• #parent_entity ⇒ ::String

  The full name of the parent entity (e.g. schema name).

• #schema ⇒ ::Google::Cloud::CloudDMS::V1::SchemaEntity

  Schema.

• #sequence ⇒ ::Google::Cloud::CloudDMS::V1::SequenceEntity

  Sequence.

• #short_name ⇒ ::String

  The short name (e.g. table name) of the entity.

• #stored_procedure ⇒ ::Google::Cloud::CloudDMS::V1::StoredProcedureEntity

  Stored procedure.

• #synonym ⇒ ::Google::Cloud::CloudDMS::V1::SynonymEntity

  Synonym.

• #table ⇒ ::Google::Cloud::CloudDMS::V1::TableEntity

  Table.

• #tree ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType

  The type of tree the entity belongs to.

• #udt ⇒ ::Google::Cloud::CloudDMS::V1::UDTEntity

  UDT.

• #view ⇒ ::Google::Cloud::CloudDMS::V1::ViewEntity

  View.

Instance Attribute Details

#database ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity

Returns Database.

Returns:

• (::Google::Cloud::CloudDMS::V1::DatabaseInstanceEntity) —

  Database.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#database_function ⇒ ::Google::Cloud::CloudDMS::V1::FunctionEntity

Returns Function.

Returns:

• (::Google::Cloud::CloudDMS::V1::FunctionEntity) —

  Function.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#database_package ⇒ ::Google::Cloud::CloudDMS::V1::PackageEntity

Returns Package.

Returns:

• (::Google::Cloud::CloudDMS::V1::PackageEntity) —

  Package.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#entity_ddl ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityDdl>

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

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#entity_type ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntityType

Returns The type of the database entity (table, view, index, ...).

Returns:

• (::Google::Cloud::CloudDMS::V1::DatabaseEntityType) —

  The type of the database entity (table, view, index, ...).

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#issues ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityIssue>

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

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#mappings ⇒ ::Array<::Google::Cloud::CloudDMS::V1::EntityMapping>

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

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#materialized_view ⇒ ::Google::Cloud::CloudDMS::V1::MaterializedViewEntity

Returns Materialized view.

Returns:

• (::Google::Cloud::CloudDMS::V1::MaterializedViewEntity) —

  Materialized view.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#parent_entity ⇒ ::String

Returns The full name of the parent entity (e.g. schema name).

Returns:

• (::String) —

  The full name of the parent entity (e.g. schema name).

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#schema ⇒ ::Google::Cloud::CloudDMS::V1::SchemaEntity

Returns Schema.

Returns:

• (::Google::Cloud::CloudDMS::V1::SchemaEntity) —

  Schema.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#sequence ⇒ ::Google::Cloud::CloudDMS::V1::SequenceEntity

Returns Sequence.

Returns:

• (::Google::Cloud::CloudDMS::V1::SequenceEntity) —

  Sequence.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#short_name ⇒ ::String

Returns The short name (e.g. table name) of the entity.

Returns:

• (::String) —

  The short name (e.g. table name) of the entity.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#stored_procedure ⇒ ::Google::Cloud::CloudDMS::V1::StoredProcedureEntity

Returns Stored procedure.

Returns:

• (::Google::Cloud::CloudDMS::V1::StoredProcedureEntity) —

  Stored procedure.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#synonym ⇒ ::Google::Cloud::CloudDMS::V1::SynonymEntity

Returns Synonym.

Returns:

• (::Google::Cloud::CloudDMS::V1::SynonymEntity) —

  Synonym.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#table ⇒ ::Google::Cloud::CloudDMS::V1::TableEntity

Returns Table.

Returns:

• (::Google::Cloud::CloudDMS::V1::TableEntity) —

  Table.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#tree ⇒ ::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType

Returns The type of tree the entity belongs to.

Returns:

• (::Google::Cloud::CloudDMS::V1::DatabaseEntity::TreeType) —

  The type of tree the entity belongs to.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#udt ⇒ ::Google::Cloud::CloudDMS::V1::UDTEntity

Returns UDT.

Returns:

• (::Google::Cloud::CloudDMS::V1::UDTEntity) —

  UDT.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end

#view ⇒ ::Google::Cloud::CloudDMS::V1::ViewEntity

Returns View.

Returns:

• (::Google::Cloud::CloudDMS::V1::ViewEntity) —

  View.

# File 'proto_docs/google/cloud/clouddms/v1/conversionworkspace_resources.rb', line 806

class DatabaseEntity
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of database entities tree.
  module TreeType
    # Tree type unspecified.
    TREE_TYPE_UNSPECIFIED = 0

    # Tree of entities loaded from a source database.
    SOURCE = 1

    # Tree of entities converted from the source tree using the mapping rules.
    DRAFT = 2

    # Tree of entities observed on the destination database.
    DESTINATION = 3
  end
end