Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::Entry (v0.11.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_date_sharded_spec=

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

#bigquery_table_spec

def bigquery_table_spec() -> ::Google::Cloud::DataCatalog::V1::BigQueryTableSpec
Returns

#bigquery_table_spec=

def bigquery_table_spec=(value) -> ::Google::Cloud::DataCatalog::V1::BigQueryTableSpec
Parameter
Returns

#business_context

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

#business_context=

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

#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

#data_source_connection_spec=

def data_source_connection_spec=(value) -> ::Google::Cloud::DataCatalog::V1::DataSourceConnectionSpec
Parameter
Returns

#database_table_spec

def database_table_spec() -> ::Google::Cloud::DataCatalog::V1::DatabaseTableSpec
Returns

#database_table_spec=

def database_table_spec=(value) -> ::Google::Cloud::DataCatalog::V1::DatabaseTableSpec
Parameter
Returns

#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 name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 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 name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

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

    The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum size is 200 bytes when encoded in UTF-8. Default value is an empty string.

#fileset_spec

def fileset_spec() -> ::Google::Cloud::DataCatalog::V1::FilesetSpec
Returns

#fileset_spec=

def fileset_spec=(value) -> ::Google::Cloud::DataCatalog::V1::FilesetSpec
Parameter
Returns

#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 afterwards. Can be used for search and lookup of the entries.

    FQNs take two forms:

    • For non-regionalized resources:

    {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    • For regionalized resources:

    {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    Example for a DPMS table:

    dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

#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 afterwards. Can be used for search and lookup of the entries.

    FQNs take two forms:

    • For non-regionalized resources:

    {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    • For regionalized resources:

    {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    Example for a DPMS table:

    dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

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 afterwards. Can be used for search and lookup of the entries.

    FQNs take two forms:

    • For non-regionalized resources:

    {SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    • For regionalized resources:

    {SYSTEM}:{PROJECT}.{LOCATION_ID}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}

    Example for a DPMS table:

    dataproc_metastore:{PROJECT_ID}.{LOCATION_ID}.{INSTANCE_ID}.{DATABASE_ID}.{TABLE_ID}

#gcs_fileset_spec

def gcs_fileset_spec() -> ::Google::Cloud::DataCatalog::V1::GcsFilesetSpec
Returns

#gcs_fileset_spec=

def gcs_fileset_spec=(value) -> ::Google::Cloud::DataCatalog::V1::GcsFilesetSpec
Parameter
Returns

#integrated_system

def integrated_system() -> ::Google::Cloud::DataCatalog::V1::IntegratedSystem
Returns

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

#name

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

#routine_spec=

def routine_spec=(value) -> ::Google::Cloud::DataCatalog::V1::RoutineSpec
Parameter
Returns

#schema

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

#schema=

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

#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 type listed in the EntryType enum. For entries with user_specified_type, 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 type listed in the EntryType enum. For entries with user_specified_type, 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 type listed in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty timestamp.

#type

def type() -> ::Google::Cloud::DataCatalog::V1::EntryType
Returns
  • (::Google::Cloud::DataCatalog::V1::EntryType) — The type of the entry. Only used for entries with types listed in the EntryType enum.

    Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

#type=

def type=(value) -> ::Google::Cloud::DataCatalog::V1::EntryType
Parameter
  • value (::Google::Cloud::DataCatalog::V1::EntryType) — The type of the entry. Only used for entries with types listed in the EntryType enum.

    Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

Returns
  • (::Google::Cloud::DataCatalog::V1::EntryType) — The type of the entry. Only used for entries with types listed in the EntryType enum.

    Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

#usage_signal

def usage_signal() -> ::Google::Cloud::DataCatalog::V1::UsageSignal
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.

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

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

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