Google Cloud Data Catalog V1 Client - Class LookupEntryRequest (1.7.1)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class LookupEntryRequest.

Request message for LookupEntry.

Generated from protobuf message google.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, 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}`
`↳ 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 the Lexical structure in Standard SQL.
`↳ 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 of `DPMS` or `DATAPLEX` `integrated_system` using its `fully_qualified_name`. Ignored in other cases.
`↳ location`	`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.

getLinkedResource

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}

Returns
Type	Description
`string`

hasLinkedResource

setLinkedResource

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}

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSqlResource

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 Standard SQL.

Returns
Type	Description
`string`

hasSqlResource

setSqlResource

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 Standard SQL.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getFullyQualifiedName

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}

Returns
Type	Description
`string`

hasFullyQualifiedName

setFullyQualifiedName

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}

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 of DPMS or DATAPLEX integrated_system using its fully_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 of DPMS or DATAPLEX integrated_system using its fully_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 of DPMS or DATAPLEX integrated_system using its fully_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 of DPMS or DATAPLEX integrated_system using its fully_qualified_name. Ignored in other cases.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTargetName

Returns
Type	Description
`string`