com.google.cloud.datacatalog.v1

Interface LookupEntryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

LookupEntryRequest, LookupEntryRequest.Builder

public interface LookupEntryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFullyQualifiedName() [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource.
com.google.protobuf.ByteString	getFullyQualifiedNameBytes() [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource.
String	getLinkedResource() The full name of the Google Cloud Platform resource the Data Catalog entry represents.
com.google.protobuf.ByteString	getLinkedResourceBytes() The full name of the Google Cloud Platform resource the Data Catalog entry represents.
String	getLocation() Location where the lookup should be performed.
com.google.protobuf.ByteString	getLocationBytes() Location where the lookup should be performed.
String	getProject() Project where the lookup should be performed.
com.google.protobuf.ByteString	getProjectBytes() Project where the lookup should be performed.
String	getSqlResource() The SQL name of the entry.
com.google.protobuf.ByteString	getSqlResourceBytes() The SQL name of the entry.
LookupEntryRequest.TargetNameCase	getTargetNameCase()
boolean	hasFullyQualifiedName() [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource.
boolean	hasLinkedResource() The full name of the Google Cloud Platform resource the Data Catalog entry represents.
boolean	hasSqlResource() The SQL name of the entry.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasLinkedResource

boolean hasLinkedResource()

 The full name of the Google Cloud Platform resource the Data Catalog
 entry represents. For more information, see [Full Resource Name]
 (https://cloud.google.com/apis/design/resource_names#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}`
 

string linked_resource = 1;

Returns:

Whether the linkedResource field is set.

getLinkedResource

String getLinkedResource()

 The full name of the Google Cloud Platform resource the Data Catalog
 entry represents. For more information, see [Full Resource Name]
 (https://cloud.google.com/apis/design/resource_names#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}`
 

string linked_resource = 1;

Returns:

The linkedResource.

getLinkedResourceBytes

com.google.protobuf.ByteString getLinkedResourceBytes()

 The full name of the Google Cloud Platform resource the Data Catalog
 entry represents. For more information, see [Full Resource Name]
 (https://cloud.google.com/apis/design/resource_names#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}`
 

string linked_resource = 1;

Returns:

The bytes for linkedResource.

hasSqlResource

boolean hasSqlResource()

 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]
 (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
 

string sql_resource = 3;

Returns:

Whether the sqlResource field is set.

getSqlResource

String 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]
 (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
 

string sql_resource = 3;

Returns:

The sqlResource.

getSqlResourceBytes

com.google.protobuf.ByteString getSqlResourceBytes()

 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]
 (https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical).
 

string sql_resource = 3;

Returns:

The bytes for sqlResource.

hasFullyQualifiedName

boolean hasFullyQualifiedName()

 [Fully Qualified Name
 (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names)
 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}`
 

string fully_qualified_name = 5;

Returns:

Whether the fullyQualifiedName field is set.

getFullyQualifiedName

String getFullyQualifiedName()

 [Fully Qualified Name
 (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names)
 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}`
 

string fully_qualified_name = 5;

Returns:

The fullyQualifiedName.

getFullyQualifiedNameBytes

com.google.protobuf.ByteString getFullyQualifiedNameBytes()

 [Fully Qualified Name
 (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names)
 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}`
 

string fully_qualified_name = 5;

Returns:

The bytes for fullyQualifiedName.

getProject

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

string project = 6;

Returns:

The project.

getProjectBytes

com.google.protobuf.ByteString getProjectBytes()

 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.
 

string project = 6;

Returns:

The bytes for project.

getLocation

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

string location = 7;

Returns:

The location.

getLocationBytes

com.google.protobuf.ByteString getLocationBytes()

 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.
 

string location = 7;

Returns:

The bytes for location.

getTargetNameCase

LookupEntryRequest.TargetNameCase getTargetNameCase()