public sealed class SearchCatalogResult : IMessage<SearchCatalogResult>, IEquatable<SearchCatalogResult>, IDeepCloneable<SearchCatalogResult>, IBufferMessage, IMessage
Reference documentation and code samples for the Data Catalog v1 API class SearchCatalogResult.
Result in the response to a search request.
Each result captures details of one entry that matches the search.
Implements
IMessageSearchCatalogResult, IEquatableSearchCatalogResult, IDeepCloneableSearchCatalogResult, IBufferMessage, IMessageInherited Members
Namespace
Google.Cloud.DataCatalog.V1Assembly
Google.Cloud.DataCatalog.V1.dll
Constructors
SearchCatalogResult()
public SearchCatalogResult()
SearchCatalogResult(SearchCatalogResult)
public SearchCatalogResult(SearchCatalogResult other)
Parameter | |
---|---|
Name | Description |
other |
SearchCatalogResult |
Properties
Description
public string Description { get; set; }
Entry description that can consist of several sentences or paragraphs that describe entry contents.
Property Value | |
---|---|
Type | Description |
string |
DisplayName
public string DisplayName { get; set; }
The display name of the result.
Property Value | |
---|---|
Type | Description |
string |
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 |
HasIntegratedSystem
public bool HasIntegratedSystem { get; }
Gets whether the "integrated_system" field is set
Property Value | |
---|---|
Type | Description |
bool |
HasUserSpecifiedSystem
public bool HasUserSpecifiedSystem { get; }
Gets whether the "user_specified_system" field is set
Property Value | |
---|---|
Type | Description |
bool |
IntegratedSystem
public IntegratedSystem IntegratedSystem { get; set; }
Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
Property Value | |
---|---|
Type | Description |
IntegratedSystem |
LinkedResource
public string LinkedResource { get; set; }
The full name of the Google Cloud resource the entry belongs to.
For more information, see Full Resource Name.
Example:
//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
Property Value | |
---|---|
Type | Description |
string |
ModifyTime
public Timestamp ModifyTime { get; set; }
The last modification timestamp of the entry in the source system.
Property Value | |
---|---|
Type | Description |
Timestamp |
RelativeResourceName
public string RelativeResourceName { get; set; }
The relative name of the resource in URL format.
Examples:
projects/{PROJECT_ID}/locations/{LOCATION_ID}/entryGroups/{ENTRY_GROUP_ID}/entries/{ENTRY_ID}
projects/{PROJECT_ID}/tagTemplates/{TAG_TEMPLATE_ID}
Property Value | |
---|---|
Type | Description |
string |
SearchResultSubtype
public string SearchResultSubtype { get; set; }
Sub-type of the search result.
A dot-delimited full type of the resource. The same type you
specify in the type
search predicate.
Examples: entry.table
, entry.dataStream
, tagTemplate
.
Property Value | |
---|---|
Type | Description |
string |
SearchResultType
public SearchResultType SearchResultType { get; set; }
Type of the search result.
You can use this field to determine which get method to call to fetch the full resource.
Property Value | |
---|---|
Type | Description |
SearchResultType |
SystemCase
public SearchCatalogResult.SystemOneofCase SystemCase { get; }
Property Value | |
---|---|
Type | Description |
SearchCatalogResultSystemOneofCase |
UserSpecifiedSystem
public string UserSpecifiedSystem { get; set; }
Custom source system that you can manually integrate Data Catalog with.
Property Value | |
---|---|
Type | Description |
string |