Data Catalog V1 API - Class Google::Cloud::DataCatalog::V1::LookupEntryRequest (v2.5.0)

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

Request message for LookupEntry.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#fully_qualified_name

def fully_qualified_name() -> ::String
Returns
  • (::String) — Fully Qualified Name (FQN) of the resource.

    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}

    Note: The following fields are mutually exclusive: fully_qualified_name, linked_resource, sql_resource. 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=(value) -> ::String
Parameter
  • value (::String) — Fully Qualified Name (FQN) of the resource.

    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}

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

Returns
  • (::String) — Fully Qualified Name (FQN) of the resource.

    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}

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

#linked_resource

def linked_resource() -> ::String
Returns
  • (::String) — The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see Full Resource Name.

    Full names are case-sensitive. For example:

    • //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
    • //pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}

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

#linked_resource=

def linked_resource=(value) -> ::String
Parameter
  • value (::String) — The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see Full Resource Name.

    Full names are case-sensitive. For example:

    • //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
    • //pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}

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

Returns
  • (::String) — The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, see Full Resource Name.

    Full names are case-sensitive. For example:

    • //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
    • //pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}

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

#location

def location() -> ::String
Returns
  • (::String) — Location where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

#location=

def location=(value) -> ::String
Parameter
  • value (::String) — Location where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.
Returns
  • (::String) — Location where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

#project

def project() -> ::String
Returns
  • (::String) — Project where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

#project=

def project=(value) -> ::String
Parameter
  • value (::String) — Project where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.
Returns
  • (::String) — Project where the lookup should be performed. Required to lookup entry that is not a part of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

#sql_resource

def sql_resource() -> ::String
Returns
  • (::String) — The SQL name of the entry. SQL names are case-sensitive.

    Examples:

    • pubsub.topic.{PROJECT_ID}.{TOPIC_ID}
    • pubsub.topic.{PROJECT_ID}.`{TOPIC.ID.SEPARATED.WITH.DOTS}`
    • bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}
    • bigquery.dataset.{PROJECT_ID}.{DATASET_ID}
    • datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}

    Identifiers (*_ID) should comply with the Lexical structure in GoogleSQL.

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

#sql_resource=

def sql_resource=(value) -> ::String
Parameter
  • value (::String) — The SQL name of the entry. SQL names are case-sensitive.

    Examples:

    • pubsub.topic.{PROJECT_ID}.{TOPIC_ID}
    • pubsub.topic.{PROJECT_ID}.`{TOPIC.ID.SEPARATED.WITH.DOTS}`
    • bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}
    • bigquery.dataset.{PROJECT_ID}.{DATASET_ID}
    • datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}

    Identifiers (*_ID) should comply with the Lexical structure in GoogleSQL.

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

Returns
  • (::String) — The SQL name of the entry. SQL names are case-sensitive.

    Examples:

    • pubsub.topic.{PROJECT_ID}.{TOPIC_ID}
    • pubsub.topic.{PROJECT_ID}.`{TOPIC.ID.SEPARATED.WITH.DOTS}`
    • bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}
    • bigquery.dataset.{PROJECT_ID}.{DATASET_ID}
    • datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}

    Identifiers (*_ID) should comply with the Lexical structure in GoogleSQL.

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