Class DatabaseEntity (2.42.0)

public final class DatabaseEntity extends GeneratedMessageV3 implements DatabaseEntityOrBuilder

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.

Protobuf type google.cloud.clouddms.v1.DatabaseEntity

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_FUNCTION_FIELD_NUMBER

public static final int DATABASE_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_PACKAGE_FIELD_NUMBER

public static final int DATABASE_PACKAGE_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_DDL_FIELD_NUMBER

public static final int ENTITY_DDL_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_TYPE_FIELD_NUMBER

public static final int ENTITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

ISSUES_FIELD_NUMBER

public static final int ISSUES_FIELD_NUMBER
Field Value
Type Description
int

MAPPINGS_FIELD_NUMBER

public static final int MAPPINGS_FIELD_NUMBER
Field Value
Type Description
int

MATERIALIZED_VIEW_FIELD_NUMBER

public static final int MATERIALIZED_VIEW_FIELD_NUMBER
Field Value
Type Description
int

PARENT_ENTITY_FIELD_NUMBER

public static final int PARENT_ENTITY_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_FIELD_NUMBER

public static final int SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

SEQUENCE_FIELD_NUMBER

public static final int SEQUENCE_FIELD_NUMBER
Field Value
Type Description
int

SHORT_NAME_FIELD_NUMBER

public static final int SHORT_NAME_FIELD_NUMBER
Field Value
Type Description
int

STORED_PROCEDURE_FIELD_NUMBER

public static final int STORED_PROCEDURE_FIELD_NUMBER
Field Value
Type Description
int

SYNONYM_FIELD_NUMBER

public static final int SYNONYM_FIELD_NUMBER
Field Value
Type Description
int

TABLE_FIELD_NUMBER

public static final int TABLE_FIELD_NUMBER
Field Value
Type Description
int

TREE_FIELD_NUMBER

public static final int TREE_FIELD_NUMBER
Field Value
Type Description
int

UDT_FIELD_NUMBER

public static final int UDT_FIELD_NUMBER
Field Value
Type Description
int

VIEW_FIELD_NUMBER

public static final int VIEW_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DatabaseEntity getDefaultInstance()
Returns
Type Description
DatabaseEntity

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DatabaseEntity.Builder newBuilder()
Returns
Type Description
DatabaseEntity.Builder

newBuilder(DatabaseEntity prototype)

public static DatabaseEntity.Builder newBuilder(DatabaseEntity prototype)
Parameter
Name Description
prototype DatabaseEntity
Returns
Type Description
DatabaseEntity.Builder

parseDelimitedFrom(InputStream input)

public static DatabaseEntity parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DatabaseEntity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DatabaseEntity parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DatabaseEntity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DatabaseEntity parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DatabaseEntity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DatabaseEntity parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DatabaseEntity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DatabaseEntity parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DatabaseEntity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DatabaseEntity parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DatabaseEntity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DatabaseEntity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DatabaseEntity> parser()
Returns
Type Description
Parser<DatabaseEntity>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabase()

public DatabaseInstanceEntity getDatabase()

Database.

.google.cloud.clouddms.v1.DatabaseInstanceEntity database = 101;

Returns
Type Description
DatabaseInstanceEntity

The database.

getDatabaseFunction()

public FunctionEntity getDatabaseFunction()

Function.

.google.cloud.clouddms.v1.FunctionEntity database_function = 107;

Returns
Type Description
FunctionEntity

The databaseFunction.

getDatabaseFunctionOrBuilder()

public FunctionEntityOrBuilder getDatabaseFunctionOrBuilder()

Function.

.google.cloud.clouddms.v1.FunctionEntity database_function = 107;

Returns
Type Description
FunctionEntityOrBuilder

getDatabaseOrBuilder()

public DatabaseInstanceEntityOrBuilder getDatabaseOrBuilder()

Database.

.google.cloud.clouddms.v1.DatabaseInstanceEntity database = 101;

Returns
Type Description
DatabaseInstanceEntityOrBuilder

getDatabasePackage()

public PackageEntity getDatabasePackage()

Package.

.google.cloud.clouddms.v1.PackageEntity database_package = 109;

Returns
Type Description
PackageEntity

The databasePackage.

getDatabasePackageOrBuilder()

public PackageEntityOrBuilder getDatabasePackageOrBuilder()

Package.

.google.cloud.clouddms.v1.PackageEntity database_package = 109;

Returns
Type Description
PackageEntityOrBuilder

getDefaultInstanceForType()

public DatabaseEntity getDefaultInstanceForType()
Returns
Type Description
DatabaseEntity

getEntityBodyCase()

public DatabaseEntity.EntityBodyCase getEntityBodyCase()
Returns
Type Description
DatabaseEntity.EntityBodyCase

getEntityDdl(int index)

public EntityDdl getEntityDdl(int index)

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.

repeated .google.cloud.clouddms.v1.EntityDdl entity_ddl = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityDdl

getEntityDdlCount()

public int getEntityDdlCount()

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.

repeated .google.cloud.clouddms.v1.EntityDdl entity_ddl = 6;

Returns
Type Description
int

getEntityDdlList()

public List<EntityDdl> getEntityDdlList()

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.

repeated .google.cloud.clouddms.v1.EntityDdl entity_ddl = 6;

Returns
Type Description
List<EntityDdl>

getEntityDdlOrBuilder(int index)

public EntityDdlOrBuilder getEntityDdlOrBuilder(int index)

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.

repeated .google.cloud.clouddms.v1.EntityDdl entity_ddl = 6;

Parameter
Name Description
index int
Returns
Type Description
EntityDdlOrBuilder

getEntityDdlOrBuilderList()

public List<? extends EntityDdlOrBuilder> getEntityDdlOrBuilderList()

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.

repeated .google.cloud.clouddms.v1.EntityDdl entity_ddl = 6;

Returns
Type Description
List<? extends com.google.cloud.clouddms.v1.EntityDdlOrBuilder>

getEntityType()

public DatabaseEntityType getEntityType()

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

.google.cloud.clouddms.v1.DatabaseEntityType entity_type = 4;

Returns
Type Description
DatabaseEntityType

The entityType.

getEntityTypeValue()

public int getEntityTypeValue()

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

.google.cloud.clouddms.v1.DatabaseEntityType entity_type = 4;

Returns
Type Description
int

The enum numeric value on the wire for entityType.

getIssues(int index)

public EntityIssue getIssues(int index)

Details about the various issues found for the entity.

repeated .google.cloud.clouddms.v1.EntityIssue issues = 7;

Parameter
Name Description
index int
Returns
Type Description
EntityIssue

getIssuesCount()

public int getIssuesCount()

Details about the various issues found for the entity.

repeated .google.cloud.clouddms.v1.EntityIssue issues = 7;

Returns
Type Description
int

getIssuesList()

public List<EntityIssue> getIssuesList()

Details about the various issues found for the entity.

repeated .google.cloud.clouddms.v1.EntityIssue issues = 7;

Returns
Type Description
List<EntityIssue>

getIssuesOrBuilder(int index)

public EntityIssueOrBuilder getIssuesOrBuilder(int index)

Details about the various issues found for the entity.

repeated .google.cloud.clouddms.v1.EntityIssue issues = 7;

Parameter
Name Description
index int
Returns
Type Description
EntityIssueOrBuilder

getIssuesOrBuilderList()

public List<? extends EntityIssueOrBuilder> getIssuesOrBuilderList()

Details about the various issues found for the entity.

repeated .google.cloud.clouddms.v1.EntityIssue issues = 7;

Returns
Type Description
List<? extends com.google.cloud.clouddms.v1.EntityIssueOrBuilder>

getMappings(int index)

public EntityMapping getMappings(int index)

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.

repeated .google.cloud.clouddms.v1.EntityMapping mappings = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityMapping

getMappingsCount()

public int getMappingsCount()

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.

repeated .google.cloud.clouddms.v1.EntityMapping mappings = 5;

Returns
Type Description
int

getMappingsList()

public List<EntityMapping> getMappingsList()

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.

repeated .google.cloud.clouddms.v1.EntityMapping mappings = 5;

Returns
Type Description
List<EntityMapping>

getMappingsOrBuilder(int index)

public EntityMappingOrBuilder getMappingsOrBuilder(int index)

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.

repeated .google.cloud.clouddms.v1.EntityMapping mappings = 5;

Parameter
Name Description
index int
Returns
Type Description
EntityMappingOrBuilder

getMappingsOrBuilderList()

public List<? extends EntityMappingOrBuilder> getMappingsOrBuilderList()

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.

repeated .google.cloud.clouddms.v1.EntityMapping mappings = 5;

Returns
Type Description
List<? extends com.google.cloud.clouddms.v1.EntityMappingOrBuilder>

getMaterializedView()

public MaterializedViewEntity getMaterializedView()

Materialized view.

.google.cloud.clouddms.v1.MaterializedViewEntity materialized_view = 111;

Returns
Type Description
MaterializedViewEntity

The materializedView.

getMaterializedViewOrBuilder()

public MaterializedViewEntityOrBuilder getMaterializedViewOrBuilder()

Materialized view.

.google.cloud.clouddms.v1.MaterializedViewEntity materialized_view = 111;

Returns
Type Description
MaterializedViewEntityOrBuilder

getParentEntity()

public String getParentEntity()

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

string parent_entity = 2;

Returns
Type Description
String

The parentEntity.

getParentEntityBytes()

public ByteString getParentEntityBytes()

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

string parent_entity = 2;

Returns
Type Description
ByteString

The bytes for parentEntity.

getParserForType()

public Parser<DatabaseEntity> getParserForType()
Returns
Type Description
Parser<DatabaseEntity>
Overrides

getSchema()

public SchemaEntity getSchema()

Schema.

.google.cloud.clouddms.v1.SchemaEntity schema = 102;

Returns
Type Description
SchemaEntity

The schema.

getSchemaOrBuilder()

public SchemaEntityOrBuilder getSchemaOrBuilder()

Schema.

.google.cloud.clouddms.v1.SchemaEntity schema = 102;

Returns
Type Description
SchemaEntityOrBuilder

getSequence()

public SequenceEntity getSequence()

Sequence.

.google.cloud.clouddms.v1.SequenceEntity sequence = 105;

Returns
Type Description
SequenceEntity

The sequence.

getSequenceOrBuilder()

public SequenceEntityOrBuilder getSequenceOrBuilder()

Sequence.

.google.cloud.clouddms.v1.SequenceEntity sequence = 105;

Returns
Type Description
SequenceEntityOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShortName()

public String getShortName()

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

string short_name = 1;

Returns
Type Description
String

The shortName.

getShortNameBytes()

public ByteString getShortNameBytes()

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

string short_name = 1;

Returns
Type Description
ByteString

The bytes for shortName.

getStoredProcedure()

public StoredProcedureEntity getStoredProcedure()

Stored procedure.

.google.cloud.clouddms.v1.StoredProcedureEntity stored_procedure = 106;

Returns
Type Description
StoredProcedureEntity

The storedProcedure.

getStoredProcedureOrBuilder()

public StoredProcedureEntityOrBuilder getStoredProcedureOrBuilder()

Stored procedure.

.google.cloud.clouddms.v1.StoredProcedureEntity stored_procedure = 106;

Returns
Type Description
StoredProcedureEntityOrBuilder

getSynonym()

public SynonymEntity getSynonym()

Synonym.

.google.cloud.clouddms.v1.SynonymEntity synonym = 108;

Returns
Type Description
SynonymEntity

The synonym.

getSynonymOrBuilder()

public SynonymEntityOrBuilder getSynonymOrBuilder()

Synonym.

.google.cloud.clouddms.v1.SynonymEntity synonym = 108;

Returns
Type Description
SynonymEntityOrBuilder

getTable()

public TableEntity getTable()

Table.

.google.cloud.clouddms.v1.TableEntity table = 103;

Returns
Type Description
TableEntity

The table.

getTableOrBuilder()

public TableEntityOrBuilder getTableOrBuilder()

Table.

.google.cloud.clouddms.v1.TableEntity table = 103;

Returns
Type Description
TableEntityOrBuilder

getTree()

public DatabaseEntity.TreeType getTree()

The type of tree the entity belongs to.

.google.cloud.clouddms.v1.DatabaseEntity.TreeType tree = 3;

Returns
Type Description
DatabaseEntity.TreeType

The tree.

getTreeValue()

public int getTreeValue()

The type of tree the entity belongs to.

.google.cloud.clouddms.v1.DatabaseEntity.TreeType tree = 3;

Returns
Type Description
int

The enum numeric value on the wire for tree.

getUdt()

public UDTEntity getUdt()

UDT.

.google.cloud.clouddms.v1.UDTEntity udt = 110;

Returns
Type Description
UDTEntity

The udt.

getUdtOrBuilder()

public UDTEntityOrBuilder getUdtOrBuilder()

UDT.

.google.cloud.clouddms.v1.UDTEntity udt = 110;

Returns
Type Description
UDTEntityOrBuilder

getView()

public ViewEntity getView()

View.

.google.cloud.clouddms.v1.ViewEntity view = 104;

Returns
Type Description
ViewEntity

The view.

getViewOrBuilder()

public ViewEntityOrBuilder getViewOrBuilder()

View.

.google.cloud.clouddms.v1.ViewEntity view = 104;

Returns
Type Description
ViewEntityOrBuilder

hasDatabase()

public boolean hasDatabase()

Database.

.google.cloud.clouddms.v1.DatabaseInstanceEntity database = 101;

Returns
Type Description
boolean

Whether the database field is set.

hasDatabaseFunction()

public boolean hasDatabaseFunction()

Function.

.google.cloud.clouddms.v1.FunctionEntity database_function = 107;

Returns
Type Description
boolean

Whether the databaseFunction field is set.

hasDatabasePackage()

public boolean hasDatabasePackage()

Package.

.google.cloud.clouddms.v1.PackageEntity database_package = 109;

Returns
Type Description
boolean

Whether the databasePackage field is set.

hasMaterializedView()

public boolean hasMaterializedView()

Materialized view.

.google.cloud.clouddms.v1.MaterializedViewEntity materialized_view = 111;

Returns
Type Description
boolean

Whether the materializedView field is set.

hasSchema()

public boolean hasSchema()

Schema.

.google.cloud.clouddms.v1.SchemaEntity schema = 102;

Returns
Type Description
boolean

Whether the schema field is set.

hasSequence()

public boolean hasSequence()

Sequence.

.google.cloud.clouddms.v1.SequenceEntity sequence = 105;

Returns
Type Description
boolean

Whether the sequence field is set.

hasStoredProcedure()

public boolean hasStoredProcedure()

Stored procedure.

.google.cloud.clouddms.v1.StoredProcedureEntity stored_procedure = 106;

Returns
Type Description
boolean

Whether the storedProcedure field is set.

hasSynonym()

public boolean hasSynonym()

Synonym.

.google.cloud.clouddms.v1.SynonymEntity synonym = 108;

Returns
Type Description
boolean

Whether the synonym field is set.

hasTable()

public boolean hasTable()

Table.

.google.cloud.clouddms.v1.TableEntity table = 103;

Returns
Type Description
boolean

Whether the table field is set.

hasUdt()

public boolean hasUdt()

UDT.

.google.cloud.clouddms.v1.UDTEntity udt = 110;

Returns
Type Description
boolean

Whether the udt field is set.

hasView()

public boolean hasView()

View.

.google.cloud.clouddms.v1.ViewEntity view = 104;

Returns
Type Description
boolean

Whether the view field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DatabaseEntity.Builder newBuilderForType()
Returns
Type Description
DatabaseEntity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DatabaseEntity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DatabaseEntity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DatabaseEntity.Builder toBuilder()
Returns
Type Description
DatabaseEntity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException