Interface EntryOrBuilder (1.60.0) 

public interface EntryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBigqueryDateShardedSpec()

public abstract BigQueryDateShardedSpec getBigqueryDateShardedSpec()

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigQueryDateShardedSpec

The bigqueryDateShardedSpec.

getBigqueryDateShardedSpecOrBuilder()

public abstract BigQueryDateShardedSpecOrBuilder getBigqueryDateShardedSpecOrBuilder()

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigQueryDateShardedSpecOrBuilder

getBigqueryTableSpec()

public abstract BigQueryTableSpec getBigqueryTableSpec()

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigQueryTableSpec

The bigqueryTableSpec.

getBigqueryTableSpecOrBuilder()

public abstract BigQueryTableSpecOrBuilder getBigqueryTableSpecOrBuilder()

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BigQueryTableSpecOrBuilder

getBusinessContext()

public abstract BusinessContext getBusinessContext()

Business Context of the entry. Not supported for BigQuery datasets

.google.cloud.datacatalog.v1.BusinessContext business_context = 37;

Returns
Type Description
BusinessContext

The businessContext.

getBusinessContextOrBuilder()

public abstract BusinessContextOrBuilder getBusinessContextOrBuilder()

Business Context of the entry. Not supported for BigQuery datasets

.google.cloud.datacatalog.v1.BusinessContext business_context = 37;

Returns
Type Description
BusinessContextOrBuilder

getCloudBigtableSystemSpec()

public abstract CloudBigtableSystemSpec getCloudBigtableSystemSpec()

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

.google.cloud.datacatalog.v1.CloudBigtableSystemSpec cloud_bigtable_system_spec = 41;

Returns
Type Description
CloudBigtableSystemSpec

The cloudBigtableSystemSpec.

getCloudBigtableSystemSpecOrBuilder()

public abstract CloudBigtableSystemSpecOrBuilder getCloudBigtableSystemSpecOrBuilder()

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

.google.cloud.datacatalog.v1.CloudBigtableSystemSpec cloud_bigtable_system_spec = 41;

Returns
Type Description
CloudBigtableSystemSpecOrBuilder

getDataSource()

public abstract DataSource getDataSource()

Output only. Physical location of the entry.

.google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataSource

The dataSource.

getDataSourceConnectionSpec()

public abstract DataSourceConnectionSpec getDataSourceConnectionSpec()

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27;

Returns
Type Description
DataSourceConnectionSpec

The dataSourceConnectionSpec.

getDataSourceConnectionSpecOrBuilder()

public abstract DataSourceConnectionSpecOrBuilder getDataSourceConnectionSpecOrBuilder()

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27;

Returns
Type Description
DataSourceConnectionSpecOrBuilder

getDataSourceOrBuilder()

public abstract DataSourceOrBuilder getDataSourceOrBuilder()

Output only. Physical location of the entry.

.google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataSourceOrBuilder

getDatabaseTableSpec()

public abstract DatabaseTableSpec getDatabaseTableSpec()

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;

Returns
Type Description
DatabaseTableSpec

The databaseTableSpec.

getDatabaseTableSpecOrBuilder()

public abstract DatabaseTableSpecOrBuilder getDatabaseTableSpecOrBuilder()

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;

Returns
Type Description
DatabaseTableSpecOrBuilder

getDatasetSpec()

public abstract DatasetSpec getDatasetSpec()

Specification that applies to a dataset.

.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;

Returns
Type Description
DatasetSpec

The datasetSpec.

getDatasetSpecOrBuilder()

public abstract DatasetSpecOrBuilder getDatasetSpecOrBuilder()

Specification that applies to a dataset.

.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;

Returns
Type Description
DatasetSpecOrBuilder

getDescription()

public abstract String getDescription()

Entry description that can consist of several sentences or paragraphs that describe entry contents.

The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.

string description = 4;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Entry description that can consist of several sentences or paragraphs that describe entry contents.

The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.

string description = 4;

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public abstract String getDisplayName()

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

string display_name = 3;

Returns
Type Description
ByteString

The bytes for displayName.

getEntryTypeCase()

public abstract Entry.EntryTypeCase getEntryTypeCase()
Returns
Type Description
Entry.EntryTypeCase

getFeatureOnlineStoreSpec()

public abstract FeatureOnlineStoreSpec getFeatureOnlineStoreSpec()

FeatureonlineStore spec for Vertex AI Feature Store.

.google.cloud.datacatalog.v1.FeatureOnlineStoreSpec feature_online_store_spec = 45;

Returns
Type Description
FeatureOnlineStoreSpec

The featureOnlineStoreSpec.

getFeatureOnlineStoreSpecOrBuilder()

public abstract FeatureOnlineStoreSpecOrBuilder getFeatureOnlineStoreSpecOrBuilder()

FeatureonlineStore spec for Vertex AI Feature Store.

.google.cloud.datacatalog.v1.FeatureOnlineStoreSpec feature_online_store_spec = 45;

Returns
Type Description
FeatureOnlineStoreSpecOrBuilder

getFilesetSpec()

public abstract FilesetSpec getFilesetSpec()

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;

Returns
Type Description
FilesetSpec

The filesetSpec.

getFilesetSpecOrBuilder()

public abstract FilesetSpecOrBuilder getFilesetSpecOrBuilder()

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;

Returns
Type Description
FilesetSpecOrBuilder

getFullyQualifiedName()

public abstract String getFullyQualifiedName()

Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.

string fully_qualified_name = 29;

Returns
Type Description
String

The fullyQualifiedName.

getFullyQualifiedNameBytes()

public abstract ByteString getFullyQualifiedNameBytes()

Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.

string fully_qualified_name = 29;

Returns
Type Description
ByteString

The bytes for fullyQualifiedName.

getGcsFilesetSpec()

public abstract GcsFilesetSpec getGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;

Returns
Type Description
GcsFilesetSpec

The gcsFilesetSpec.

getGcsFilesetSpecOrBuilder()

public abstract GcsFilesetSpecOrBuilder getGcsFilesetSpecOrBuilder()

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;

Returns
Type Description
GcsFilesetSpecOrBuilder

getIntegratedSystem()

public abstract IntegratedSystem getIntegratedSystem()

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IntegratedSystem

The integratedSystem.

getIntegratedSystemValue()

public abstract int getIntegratedSystemValue()

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for integratedSystem.

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Cloud labels attached to the entry.

In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.

map<string, string> labels = 14;

Parameter
Name Description
key String
Returns
Type Description
String

getLinkedResource()

public abstract String getLinkedResource()

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the Full Resource Name. For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Output only when the entry is one of the types in the EntryType enum.

For entries with a user_specified_type, this field is optional and defaults to an empty string.

The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.

string linked_resource = 9;

Returns
Type Description
String

The linkedResource.

getLinkedResourceBytes()

public abstract ByteString getLinkedResourceBytes()

The resource this metadata entry refers to.

For Google Cloud Platform resources, linked_resource is the Full Resource Name. For example, the linked_resource for a table resource from BigQuery is:

//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}

Output only when the entry is one of the types in the EntryType enum.

For entries with a user_specified_type, this field is optional and defaults to an empty string.

The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.

string linked_resource = 9;

Returns
Type Description
ByteString

The bytes for linkedResource.

getLookerSystemSpec()

public abstract LookerSystemSpec getLookerSystemSpec()

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;

Returns
Type Description
LookerSystemSpec

The lookerSystemSpec.

getLookerSystemSpecOrBuilder()

public abstract LookerSystemSpecOrBuilder getLookerSystemSpecOrBuilder()

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;

Returns
Type Description
LookerSystemSpecOrBuilder

getModelSpec()

public abstract ModelSpec getModelSpec()

Model specification.

.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;

Returns
Type Description
ModelSpec

The modelSpec.

getModelSpecOrBuilder()

public abstract ModelSpecOrBuilder getModelSpecOrBuilder()

Model specification.

.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;

Returns
Type Description
ModelSpecOrBuilder

getName()

public abstract String getName()

Output only. Identifier. The resource name of an entry in URL format.

Note: The entry itself and its child resources might not be stored in the location specified in its name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Identifier. The resource name of an entry in URL format.

Note: The entry itself and its child resources might not be stored in the location specified in its name.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getPersonalDetails()

public abstract PersonalDetails getPersonalDetails()

Output only. Additional information related to the entry. Private to the current user.

.google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PersonalDetails

The personalDetails.

getPersonalDetailsOrBuilder()

public abstract PersonalDetailsOrBuilder getPersonalDetailsOrBuilder()

Output only. Additional information related to the entry. Private to the current user.

.google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PersonalDetailsOrBuilder

getRoutineSpec()

public abstract RoutineSpec getRoutineSpec()

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;

Returns
Type Description
RoutineSpec

The routineSpec.

getRoutineSpecOrBuilder()

public abstract RoutineSpecOrBuilder getRoutineSpecOrBuilder()

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;

Returns
Type Description
RoutineSpecOrBuilder

getSchema()

public abstract Schema getSchema()

Schema of the entry. An entry might not have any schema attached to it.

.google.cloud.datacatalog.v1.Schema schema = 5;

Returns
Type Description
Schema

The schema.

getSchemaOrBuilder()

public abstract SchemaOrBuilder getSchemaOrBuilder()

Schema of the entry. An entry might not have any schema attached to it.

.google.cloud.datacatalog.v1.Schema schema = 5;

Returns
Type Description
SchemaOrBuilder

getServiceSpec()

public abstract ServiceSpec getServiceSpec()

Specification that applies to a Service resource.

.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;

Returns
Type Description
ServiceSpec

The serviceSpec.

getServiceSpecOrBuilder()

public abstract ServiceSpecOrBuilder getServiceSpecOrBuilder()

Specification that applies to a Service resource.

.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;

Returns
Type Description
ServiceSpecOrBuilder

getSourceSystemTimestamps()

public abstract SystemTimestamps getSourceSystemTimestamps()

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;

Returns
Type Description
SystemTimestamps

The sourceSystemTimestamps.

getSourceSystemTimestampsOrBuilder()

public abstract SystemTimestampsOrBuilder getSourceSystemTimestampsOrBuilder()

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;

Returns
Type Description
SystemTimestampsOrBuilder

getSpecCase()

public abstract Entry.SpecCase getSpecCase()
Returns
Type Description
Entry.SpecCase

getSqlDatabaseSystemSpec()

public abstract SqlDatabaseSystemSpec getSqlDatabaseSystemSpec()

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;

Returns
Type Description
SqlDatabaseSystemSpec

The sqlDatabaseSystemSpec.

getSqlDatabaseSystemSpecOrBuilder()

public abstract SqlDatabaseSystemSpecOrBuilder getSqlDatabaseSystemSpecOrBuilder()

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;

Returns
Type Description
SqlDatabaseSystemSpecOrBuilder

getSystemCase()

public abstract Entry.SystemCase getSystemCase()
Returns
Type Description
Entry.SystemCase

getSystemSpecCase()

public abstract Entry.SystemSpecCase getSystemSpecCase()
Returns
Type Description
Entry.SystemSpecCase

getType()

public abstract EntryType getType()

The type of the entry.

For details, see EntryType.

.google.cloud.datacatalog.v1.EntryType type = 2;

Returns
Type Description
EntryType

The type.

getTypeSpecCase()

public abstract Entry.TypeSpecCase getTypeSpecCase()
Returns
Type Description
Entry.TypeSpecCase

getTypeValue()

public abstract int getTypeValue()

The type of the entry.

For details, see EntryType.

.google.cloud.datacatalog.v1.EntryType type = 2;

Returns
Type Description
int

The enum numeric value on the wire for type.

getUsageSignal()

public abstract UsageSignal getUsageSignal()

Resource usage statistics.

.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;

Returns
Type Description
UsageSignal

The usageSignal.

getUsageSignalOrBuilder()

public abstract UsageSignalOrBuilder getUsageSignalOrBuilder()

Resource usage statistics.

.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;

Returns
Type Description
UsageSignalOrBuilder

getUserSpecifiedSystem()

public abstract String getUserSpecifiedSystem()

Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
String

The userSpecifiedSystem.

getUserSpecifiedSystemBytes()

public abstract ByteString getUserSpecifiedSystemBytes()

Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
ByteString

The bytes for userSpecifiedSystem.

getUserSpecifiedType()

public abstract String getUserSpecifiedType()

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

string user_specified_type = 16;

Returns
Type Description
String

The userSpecifiedType.

getUserSpecifiedTypeBytes()

public abstract ByteString getUserSpecifiedTypeBytes()

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

string user_specified_type = 16;

Returns
Type Description
ByteString

The bytes for userSpecifiedType.

hasBigqueryDateShardedSpec()

public abstract boolean hasBigqueryDateShardedSpec()

Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern.

For more information, see Introduction to partitioned tables.

.google.cloud.datacatalog.v1.BigQueryDateShardedSpec bigquery_date_sharded_spec = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the bigqueryDateShardedSpec field is set.

hasBigqueryTableSpec()

public abstract boolean hasBigqueryTableSpec()

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

.google.cloud.datacatalog.v1.BigQueryTableSpec bigquery_table_spec = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the bigqueryTableSpec field is set.

hasBusinessContext()

public abstract boolean hasBusinessContext()

Business Context of the entry. Not supported for BigQuery datasets

.google.cloud.datacatalog.v1.BusinessContext business_context = 37;

Returns
Type Description
boolean

Whether the businessContext field is set.

hasCloudBigtableSystemSpec()

public abstract boolean hasCloudBigtableSystemSpec()

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

.google.cloud.datacatalog.v1.CloudBigtableSystemSpec cloud_bigtable_system_spec = 41;

Returns
Type Description
boolean

Whether the cloudBigtableSystemSpec field is set.

hasDataSource()

public abstract boolean hasDataSource()

Output only. Physical location of the entry.

.google.cloud.datacatalog.v1.DataSource data_source = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the dataSource field is set.

hasDataSourceConnectionSpec()

public abstract boolean hasDataSourceConnectionSpec()

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

.google.cloud.datacatalog.v1.DataSourceConnectionSpec data_source_connection_spec = 27;

Returns
Type Description
boolean

Whether the dataSourceConnectionSpec field is set.

hasDatabaseTableSpec()

public abstract boolean hasDatabaseTableSpec()

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

.google.cloud.datacatalog.v1.DatabaseTableSpec database_table_spec = 24;

Returns
Type Description
boolean

Whether the databaseTableSpec field is set.

hasDatasetSpec()

public abstract boolean hasDatasetSpec()

Specification that applies to a dataset.

.google.cloud.datacatalog.v1.DatasetSpec dataset_spec = 32;

Returns
Type Description
boolean

Whether the datasetSpec field is set.

hasFeatureOnlineStoreSpec()

public abstract boolean hasFeatureOnlineStoreSpec()

FeatureonlineStore spec for Vertex AI Feature Store.

.google.cloud.datacatalog.v1.FeatureOnlineStoreSpec feature_online_store_spec = 45;

Returns
Type Description
boolean

Whether the featureOnlineStoreSpec field is set.

hasFilesetSpec()

public abstract boolean hasFilesetSpec()

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.FilesetSpec fileset_spec = 33;

Returns
Type Description
boolean

Whether the filesetSpec field is set.

hasGcsFilesetSpec()

public abstract boolean hasGcsFilesetSpec()

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

.google.cloud.datacatalog.v1.GcsFilesetSpec gcs_fileset_spec = 6;

Returns
Type Description
boolean

Whether the gcsFilesetSpec field is set.

hasIntegratedSystem()

public abstract boolean hasIntegratedSystem()

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

.google.cloud.datacatalog.v1.IntegratedSystem integrated_system = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the integratedSystem field is set.

hasLookerSystemSpec()

public abstract boolean hasLookerSystemSpec()

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

.google.cloud.datacatalog.v1.LookerSystemSpec looker_system_spec = 40;

Returns
Type Description
boolean

Whether the lookerSystemSpec field is set.

hasModelSpec()

public abstract boolean hasModelSpec()

Model specification.

.google.cloud.datacatalog.v1.ModelSpec model_spec = 43;

Returns
Type Description
boolean

Whether the modelSpec field is set.

hasPersonalDetails()

public abstract boolean hasPersonalDetails()

Output only. Additional information related to the entry. Private to the current user.

.google.cloud.datacatalog.v1.PersonalDetails personal_details = 26 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the personalDetails field is set.

hasRoutineSpec()

public abstract boolean hasRoutineSpec()

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

.google.cloud.datacatalog.v1.RoutineSpec routine_spec = 28;

Returns
Type Description
boolean

Whether the routineSpec field is set.

hasSchema()

public abstract boolean hasSchema()

Schema of the entry. An entry might not have any schema attached to it.

.google.cloud.datacatalog.v1.Schema schema = 5;

Returns
Type Description
boolean

Whether the schema field is set.

hasServiceSpec()

public abstract boolean hasServiceSpec()

Specification that applies to a Service resource.

.google.cloud.datacatalog.v1.ServiceSpec service_spec = 42;

Returns
Type Description
boolean

Whether the serviceSpec field is set.

hasSourceSystemTimestamps()

public abstract boolean hasSourceSystemTimestamps()

Timestamps from the underlying resource, not from the Data Catalog entry.

Output only when the entry has a system listed in the IntegratedSystem enum. For entries with user_specified_system, this field is optional and defaults to an empty timestamp.

.google.cloud.datacatalog.v1.SystemTimestamps source_system_timestamps = 7;

Returns
Type Description
boolean

Whether the sourceSystemTimestamps field is set.

hasSqlDatabaseSystemSpec()

public abstract boolean hasSqlDatabaseSystemSpec()

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

.google.cloud.datacatalog.v1.SqlDatabaseSystemSpec sql_database_system_spec = 39;

Returns
Type Description
boolean

Whether the sqlDatabaseSystemSpec field is set.

hasType()

public abstract boolean hasType()

The type of the entry.

For details, see EntryType.

.google.cloud.datacatalog.v1.EntryType type = 2;

Returns
Type Description
boolean

Whether the type field is set.

hasUsageSignal()

public abstract boolean hasUsageSignal()

Resource usage statistics.

.google.cloud.datacatalog.v1.UsageSignal usage_signal = 13;

Returns
Type Description
boolean

Whether the usageSignal field is set.

hasUserSpecifiedSystem()

public abstract boolean hasUserSpecifiedSystem()

Indicates the entry's source system that Data Catalog doesn't automatically integrate with.

The user_specified_system string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

string user_specified_system = 18;

Returns
Type Description
boolean

Whether the userSpecifiedSystem field is set.

hasUserSpecifiedType()

public abstract boolean hasUserSpecifiedType()

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum.

When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type.

The user_specified_type string has the following limitations:

  • Is case insensitive.
  • Must begin with a letter or underscore.
  • Can only contain letters, numbers, and underscores.
  • Must be at least 1 character and at most 64 characters long.

string user_specified_type = 16;

Returns
Type Description
boolean

Whether the userSpecifiedType field is set.