Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class LookupEntryRequest.
Request message forLookupEntry.
Generated from protobuf messagegoogle.cloud.datacatalog.v1.LookupEntryRequest
Namespace
Google \ Cloud \ DataCatalog \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ linked_resource
string
The full name of the Google Cloud Platform resource the Data Catalog entry represents. For more information, seeFull 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}
↳ sql_resource
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 theLexical structure in GoogleSQL.
↳ fully_qualified_name
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}
↳ project
string
Project where the lookup should be performed. Required to lookup entry that is not a part ofDPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.
↳ location
string
Location where the lookup should be performed. Required to lookup entry that is not a part ofDPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.
getLinkedResource
The full name of the Google Cloud Platform resource the Data Catalog
entry represents. For more information, seeFull Resource Name.
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}
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}
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProject
Project where the lookup should be performed. Required to lookup
entry that is not a part ofDPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.
Returns
Type
Description
string
setProject
Project where the lookup should be performed. Required to lookup
entry that is not a part ofDPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getLocation
Location where the lookup should be performed. Required to lookup
entry that is not a part ofDPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.
Returns
Type
Description
string
setLocation
Location where the lookup should be performed. Required to lookup
entry that is not a part ofDPMSorDATAPLEXintegrated_systemusing itsfully_qualified_name. Ignored in other cases.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Data Catalog V1 Client - Class LookupEntryRequest (2.3.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.2 (latest)](/php/docs/reference/cloud-data-catalog/latest/V1.LookupEntryRequest)\n- [2.3.1](/php/docs/reference/cloud-data-catalog/2.3.1/V1.LookupEntryRequest)\n- [2.2.4](/php/docs/reference/cloud-data-catalog/2.2.4/V1.LookupEntryRequest)\n- [2.1.0](/php/docs/reference/cloud-data-catalog/2.1.0/V1.LookupEntryRequest)\n- [2.0.2](/php/docs/reference/cloud-data-catalog/2.0.2/V1.LookupEntryRequest)\n- [1.10.3](/php/docs/reference/cloud-data-catalog/1.10.3/V1.LookupEntryRequest)\n- [1.9.1](/php/docs/reference/cloud-data-catalog/1.9.1/V1.LookupEntryRequest)\n- [1.8.2](/php/docs/reference/cloud-data-catalog/1.8.2/V1.LookupEntryRequest)\n- [1.7.1](/php/docs/reference/cloud-data-catalog/1.7.1/V1.LookupEntryRequest)\n- [1.6.0](/php/docs/reference/cloud-data-catalog/1.6.0/V1.LookupEntryRequest)\n- [1.5.1](/php/docs/reference/cloud-data-catalog/1.5.1/V1.LookupEntryRequest)\n- [1.4.2](/php/docs/reference/cloud-data-catalog/1.4.2/V1.LookupEntryRequest)\n- [1.3.9](/php/docs/reference/cloud-data-catalog/1.3.9/V1.LookupEntryRequest) \nReference documentation and code samples for the Google Cloud Data Catalog V1 Client class LookupEntryRequest.\n\nRequest message for\nLookupEntry.\n\nGenerated from protobuf message `google.cloud.datacatalog.v1.LookupEntryRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DataCatalog \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getLinkedResource\n\nThe full name of the Google Cloud Platform resource the Data Catalog\nentry represents. For more information, see [Full Resource Name](https://cloud.google.com/apis/design/resource_names#full_resource_name).\n\nFull names are case-sensitive. For example:\n\n- `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`\n- `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`\n\n### hasLinkedResource\n\n### setLinkedResource\n\nThe full name of the Google Cloud Platform resource the Data Catalog\nentry represents. For more information, see [Full Resource Name](https://cloud.google.com/apis/design/resource_names#full_resource_name).\n\nFull names are case-sensitive. For example:\n\n- `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}`\n- `//pubsub.googleapis.com/projects/{PROJECT_ID}/topics/{TOPIC_ID}`\n\n### getSqlResource\n\nThe SQL name of the entry. SQL names are case-sensitive.\n\nExamples:\n\n- `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`\n- `pubsub.topic.{PROJECT_ID}.`\\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\\`\n- `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`\n- `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`\n- `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}` Identifiers (`*_ID`) should comply with the [Lexical structure in GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).\n\n### hasSqlResource\n\n### setSqlResource\n\nThe SQL name of the entry. SQL names are case-sensitive.\n\nExamples:\n\n- `pubsub.topic.{PROJECT_ID}.{TOPIC_ID}`\n- `pubsub.topic.{PROJECT_ID}.`\\``{TOPIC.ID.SEPARATED.WITH.DOTS}`\\`\n- `bigquery.table.{PROJECT_ID}.{DATASET_ID}.{TABLE_ID}`\n- `bigquery.dataset.{PROJECT_ID}.{DATASET_ID}`\n- `datacatalog.entry.{PROJECT_ID}.{LOCATION_ID}.{ENTRY_GROUP_ID}.{ENTRY_ID}` Identifiers (`*_ID`) should comply with the [Lexical structure in GoogleSQL](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).\n\n### getFullyQualifiedName\n\n[Fully Qualified Name\n(FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names)\nof the resource.\n\nFQNs take two forms:\n\n- For non-regionalized resources: `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`\n- 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}`\n\n### hasFullyQualifiedName\n\n### setFullyQualifiedName\n\n[Fully Qualified Name\n(FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names)\nof the resource.\n\nFQNs take two forms:\n\n- For non-regionalized resources: `{SYSTEM}:{PROJECT}.{PATH_TO_RESOURCE_SEPARATED_WITH_DOTS}`\n- 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}`\n\n### getProject\n\nProject where the lookup should be performed. Required to lookup\nentry that is not a part of `DPMS` or `DATAPLEX` `integrated_system`\nusing its `fully_qualified_name`. Ignored in other cases.\n\n### setProject\n\nProject where the lookup should be performed. Required to lookup\nentry that is not a part of `DPMS` or `DATAPLEX` `integrated_system`\nusing its `fully_qualified_name`. Ignored in other cases.\n\n### getLocation\n\nLocation where the lookup should be performed. Required to lookup\nentry that is not a part of `DPMS` or `DATAPLEX` `integrated_system`\nusing its `fully_qualified_name`. Ignored in other cases.\n\n### setLocation\n\nLocation where the lookup should be performed. Required to lookup\nentry that is not a part of `DPMS` or `DATAPLEX` `integrated_system`\nusing its `fully_qualified_name`. Ignored in other cases.\n\n### getTargetName"]]
