Data Catalog v1 API - Class LookupEntryRequest (2.11.0) 

public sealed class LookupEntryRequest : IMessage<LookupEntryRequest>, IEquatable<LookupEntryRequest>, IDeepCloneable<LookupEntryRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Data Catalog v1 API class LookupEntryRequest.

Request message for [LookupEntry][google.cloud.datacatalog.v1.DataCatalog.LookupEntry].

Inheritance

object > LookupEntryRequest

Namespace

Google.Cloud.DataCatalog.V1

Assembly

Google.Cloud.DataCatalog.V1.dll

Constructors

LookupEntryRequest()

public LookupEntryRequest()

LookupEntryRequest(LookupEntryRequest)

public LookupEntryRequest(LookupEntryRequest other)
Parameter
Name Description
other LookupEntryRequest

Properties

FullyQualifiedName

public string FullyQualifiedName { get; set; }

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}

Property Value
Type Description
string

HasFullyQualifiedName

public bool HasFullyQualifiedName { get; }

Gets whether the "fully_qualified_name" field is set

Property Value
Type Description
bool

HasLinkedResource

public bool HasLinkedResource { get; }

Gets whether the "linked_resource" field is set

Property Value
Type Description
bool

HasSqlResource

public bool HasSqlResource { get; }

Gets whether the "sql_resource" field is set

Property Value
Type Description
bool

LinkedResource

public string LinkedResource { get; set; }

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}
Property Value
Type Description
string

Location

public string Location { get; set; }

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.

Property Value
Type Description
string

Project

public string Project { get; set; }

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.

Property Value
Type Description
string

SqlResource

public string SqlResource { get; set; }

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.

Property Value
Type Description
string

TargetNameCase

public LookupEntryRequest.TargetNameOneofCase TargetNameCase { get; }
Property Value
Type Description
LookupEntryRequestTargetNameOneofCase