Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::Entry (v2.0.0)

Reference documentation and code samples for the Data Catalog V1 API class Google::Cloud::DataCatalog::V1::Entry.

Entry metadata. A Data Catalog entry represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You can use the linked_resource field in the entry resource to refer to the original resource ID of the source system.

An entry resource contains resource details, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#bigquery_date_sharded_spec

def bigquery_date_sharded_spec() -> ::Google::Cloud::DataCatalog::V1::BigQueryDateShardedSpec
Returns

#bigquery_table_spec

def bigquery_table_spec() -> ::Google::Cloud::DataCatalog::V1::BigQueryTableSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::BigQueryTableSpec) — Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

    Note: The following fields are mutually exclusive: bigquery_table_spec, gcs_fileset_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#business_context

def business_context() -> ::Google::Cloud::DataCatalog::V1::BusinessContext
Returns

#business_context=

def business_context=(value) -> ::Google::Cloud::DataCatalog::V1::BusinessContext
Parameter
Returns

#cloud_bigtable_system_spec

def cloud_bigtable_system_spec() -> ::Google::Cloud::DataCatalog::V1::CloudBigtableSystemSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::CloudBigtableSystemSpec) — Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

    Note: The following fields are mutually exclusive: cloud_bigtable_system_spec, sql_database_system_spec, looker_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#cloud_bigtable_system_spec=

def cloud_bigtable_system_spec=(value) -> ::Google::Cloud::DataCatalog::V1::CloudBigtableSystemSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::CloudBigtableSystemSpec) — Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

    Note: The following fields are mutually exclusive: cloud_bigtable_system_spec, sql_database_system_spec, looker_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::CloudBigtableSystemSpec) — Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

    Note: The following fields are mutually exclusive: cloud_bigtable_system_spec, sql_database_system_spec, looker_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_source

def data_source() -> ::Google::Cloud::DataCatalog::V1::DataSource
Returns

#data_source_connection_spec

def data_source_connection_spec() -> ::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec) — Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

    Note: The following fields are mutually exclusive: data_source_connection_spec, database_table_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_source_connection_spec=

def data_source_connection_spec=(value) -> ::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec) — Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

    Note: The following fields are mutually exclusive: data_source_connection_spec, database_table_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec) — Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

    Note: The following fields are mutually exclusive: data_source_connection_spec, database_table_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database_table_spec

def database_table_spec() -> ::Google::Cloud::DataCatalog::V1::DatabaseTableSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::DatabaseTableSpec) — Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

    Note: The following fields are mutually exclusive: database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#database_table_spec=

def database_table_spec=(value) -> ::Google::Cloud::DataCatalog::V1::DatabaseTableSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::DatabaseTableSpec) — Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

    Note: The following fields are mutually exclusive: database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::DatabaseTableSpec) — Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

    Note: The following fields are mutually exclusive: database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dataset_spec

def dataset_spec() -> ::Google::Cloud::DataCatalog::V1::DatasetSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::DatasetSpec) — Specification that applies to a dataset.

    Note: The following fields are mutually exclusive: dataset_spec, database_table_spec, data_source_connection_spec, routine_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#dataset_spec=

def dataset_spec=(value) -> ::Google::Cloud::DataCatalog::V1::DatasetSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::DatasetSpec) — Specification that applies to a dataset.

    Note: The following fields are mutually exclusive: dataset_spec, database_table_spec, data_source_connection_spec, routine_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::DatasetSpec) — Specification that applies to a dataset.

    Note: The following fields are mutually exclusive: dataset_spec, database_table_spec, data_source_connection_spec, routine_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#description

def description() -> ::String
Returns
  • (::String) — 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.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Display name of an entry.

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

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Display name of an entry.

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

Returns
  • (::String) — Display name of an entry.

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

#feature_online_store_spec

def feature_online_store_spec() -> ::Google::Cloud::DataCatalog::V1::FeatureOnlineStoreSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::FeatureOnlineStoreSpec) — FeatureonlineStore spec for Vertex AI Feature Store.

    Note: The following fields are mutually exclusive: feature_online_store_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#feature_online_store_spec=

def feature_online_store_spec=(value) -> ::Google::Cloud::DataCatalog::V1::FeatureOnlineStoreSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::FeatureOnlineStoreSpec) — FeatureonlineStore spec for Vertex AI Feature Store.

    Note: The following fields are mutually exclusive: feature_online_store_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::FeatureOnlineStoreSpec) — FeatureonlineStore spec for Vertex AI Feature Store.

    Note: The following fields are mutually exclusive: feature_online_store_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, model_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#fileset_spec

def fileset_spec() -> ::Google::Cloud::DataCatalog::V1::FilesetSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::FilesetSpec) — Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

    Note: The following fields are mutually exclusive: fileset_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#fileset_spec=

def fileset_spec=(value) -> ::Google::Cloud::DataCatalog::V1::FilesetSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::FilesetSpec) — Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

    Note: The following fields are mutually exclusive: fileset_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::FilesetSpec) — Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

    Note: The following fields are mutually exclusive: fileset_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#fully_qualified_name

def fully_qualified_name() -> ::String
Returns
  • (::String) — 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.

#fully_qualified_name=

def fully_qualified_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#gcs_fileset_spec

def gcs_fileset_spec() -> ::Google::Cloud::DataCatalog::V1::GcsFilesetSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::GcsFilesetSpec) — Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

    Note: The following fields are mutually exclusive: gcs_fileset_spec, bigquery_table_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#gcs_fileset_spec=

def gcs_fileset_spec=(value) -> ::Google::Cloud::DataCatalog::V1::GcsFilesetSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::GcsFilesetSpec) — Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

    Note: The following fields are mutually exclusive: gcs_fileset_spec, bigquery_table_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::GcsFilesetSpec) — Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

    Note: The following fields are mutually exclusive: gcs_fileset_spec, bigquery_table_spec, bigquery_date_sharded_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#integrated_system

def integrated_system() -> ::Google::Cloud::DataCatalog::V1::IntegratedSystem
Returns
  • (::Google::Cloud::DataCatalog::V1::IntegratedSystem) — Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

    Note: The following fields are mutually exclusive: integrated_system, user_specified_system. If a field in that set is populated, all other fields in the set will automatically be cleared.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#linked_resource

def linked_resource() -> ::String
Returns
  • (::String) — 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.

#linked_resource=

def linked_resource=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#looker_system_spec

def looker_system_spec() -> ::Google::Cloud::DataCatalog::V1::LookerSystemSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::LookerSystemSpec) — Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

    Note: The following fields are mutually exclusive: looker_system_spec, sql_database_system_spec, cloud_bigtable_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#looker_system_spec=

def looker_system_spec=(value) -> ::Google::Cloud::DataCatalog::V1::LookerSystemSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::LookerSystemSpec) — Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

    Note: The following fields are mutually exclusive: looker_system_spec, sql_database_system_spec, cloud_bigtable_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::LookerSystemSpec) — Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

    Note: The following fields are mutually exclusive: looker_system_spec, sql_database_system_spec, cloud_bigtable_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#model_spec

def model_spec() -> ::Google::Cloud::DataCatalog::V1::ModelSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::ModelSpec) — Model specification.

    Note: The following fields are mutually exclusive: model_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#model_spec=

def model_spec=(value) -> ::Google::Cloud::DataCatalog::V1::ModelSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::ModelSpec) — Model specification.

    Note: The following fields are mutually exclusive: model_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::ModelSpec) — Model specification.

    Note: The following fields are mutually exclusive: model_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, service_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::String) — 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.

#personal_details

def personal_details() -> ::Google::Cloud::DataCatalog::V1::PersonalDetails
Returns

#routine_spec

def routine_spec() -> ::Google::Cloud::DataCatalog::V1::RoutineSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::RoutineSpec) — Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

    Note: The following fields are mutually exclusive: routine_spec, database_table_spec, data_source_connection_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#routine_spec=

def routine_spec=(value) -> ::Google::Cloud::DataCatalog::V1::RoutineSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::RoutineSpec) — Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

    Note: The following fields are mutually exclusive: routine_spec, database_table_spec, data_source_connection_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::RoutineSpec) — Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

    Note: The following fields are mutually exclusive: routine_spec, database_table_spec, data_source_connection_spec, dataset_spec, fileset_spec, service_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#schema

def schema() -> ::Google::Cloud::DataCatalog::V1::Schema
Returns

#schema=

def schema=(value) -> ::Google::Cloud::DataCatalog::V1::Schema
Parameter
Returns

#service_spec

def service_spec() -> ::Google::Cloud::DataCatalog::V1::ServiceSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::ServiceSpec) — Specification that applies to a Service resource.

    Note: The following fields are mutually exclusive: service_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#service_spec=

def service_spec=(value) -> ::Google::Cloud::DataCatalog::V1::ServiceSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::ServiceSpec) — Specification that applies to a Service resource.

    Note: The following fields are mutually exclusive: service_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::ServiceSpec) — Specification that applies to a Service resource.

    Note: The following fields are mutually exclusive: service_spec, database_table_spec, data_source_connection_spec, routine_spec, dataset_spec, fileset_spec, model_spec, feature_online_store_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#source_system_timestamps

def source_system_timestamps() -> ::Google::Cloud::DataCatalog::V1::SystemTimestamps
Returns
  • (::Google::Cloud::DataCatalog::V1::SystemTimestamps) — 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.

#source_system_timestamps=

def source_system_timestamps=(value) -> ::Google::Cloud::DataCatalog::V1::SystemTimestamps
Parameter
  • value (::Google::Cloud::DataCatalog::V1::SystemTimestamps) — 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.

Returns
  • (::Google::Cloud::DataCatalog::V1::SystemTimestamps) — 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.

#sql_database_system_spec

def sql_database_system_spec() -> ::Google::Cloud::DataCatalog::V1::SqlDatabaseSystemSpec
Returns
  • (::Google::Cloud::DataCatalog::V1::SqlDatabaseSystemSpec) — Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

    Note: The following fields are mutually exclusive: sql_database_system_spec, looker_system_spec, cloud_bigtable_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#sql_database_system_spec=

def sql_database_system_spec=(value) -> ::Google::Cloud::DataCatalog::V1::SqlDatabaseSystemSpec
Parameter
  • value (::Google::Cloud::DataCatalog::V1::SqlDatabaseSystemSpec) — Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

    Note: The following fields are mutually exclusive: sql_database_system_spec, looker_system_spec, cloud_bigtable_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::SqlDatabaseSystemSpec) — Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

    Note: The following fields are mutually exclusive: sql_database_system_spec, looker_system_spec, cloud_bigtable_system_spec. If a field in that set is populated, all other fields in the set will automatically be cleared.

#type

def type() -> ::Google::Cloud::DataCatalog::V1::EntryType
Returns
  • (::Google::Cloud::DataCatalog::V1::EntryType) — The type of the entry.

    For details, see EntryType.

    Note: The following fields are mutually exclusive: type, user_specified_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#type=

def type=(value) -> ::Google::Cloud::DataCatalog::V1::EntryType
Parameter
  • value (::Google::Cloud::DataCatalog::V1::EntryType) — The type of the entry.

    For details, see EntryType.

    Note: The following fields are mutually exclusive: type, user_specified_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Cloud::DataCatalog::V1::EntryType) — The type of the entry.

    For details, see EntryType.

    Note: The following fields are mutually exclusive: type, user_specified_type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#usage_signal

def usage_signal() -> ::Google::Cloud::DataCatalog::V1::UsageSignal
Returns

#usage_signal=

def usage_signal=(value) -> ::Google::Cloud::DataCatalog::V1::UsageSignal
Parameter
Returns

#user_specified_system

def user_specified_system() -> ::String
Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: user_specified_system, integrated_system. If a field in that set is populated, all other fields in the set will automatically be cleared.

#user_specified_system=

def user_specified_system=(value) -> ::String
Parameter
  • value (::String) — 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.

    Note: The following fields are mutually exclusive: user_specified_system, integrated_system. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: user_specified_system, integrated_system. If a field in that set is populated, all other fields in the set will automatically be cleared.

#user_specified_type

def user_specified_type() -> ::String
Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: user_specified_type, type. If a field in that set is populated, all other fields in the set will automatically be cleared.

#user_specified_type=

def user_specified_type=(value) -> ::String
Parameter
  • value (::String) — 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.

    Note: The following fields are mutually exclusive: user_specified_type, type. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — 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.

    Note: The following fields are mutually exclusive: user_specified_type, type. If a field in that set is populated, all other fields in the set will automatically be cleared.