Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class SearchCatalogResult.
Result in the response to a search request.
Each result captures details of one entry that matches the search.
Generated from protobuf message google.cloud.datacatalog.v1.SearchCatalogResult
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ search_result_type
int
Type of the search result. You can use this field to determine which get method to call to fetch the full resource.
↳ search_result_subtype
string
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
.
↳ relative_resource_name
string
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}
↳ linked_resource
string
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
↳ modify_time
↳ integrated_system
int
Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
↳ user_specified_system
string
Custom source system that you can manually integrate Data Catalog with.
↳ 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
↳ display_name
string
The display name of the result.
↳ description
string
Entry description that can consist of several sentences or paragraphs that describe entry contents.
getSearchResultType
Type of the search result.
You can use this field to determine which get method to call to fetch the full resource.
int
setSearchResultType
Type of the search result.
You can use this field to determine which get method to call to fetch the full resource.
var
int
$this
getSearchResultSubtype
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
.
string
setSearchResultSubtype
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
.
var
string
$this
getRelativeResourceName
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}
string
setRelativeResourceName
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}
var
string
$this
getLinkedResource
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
string
setLinkedResource
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
var
string
$this
getModifyTime
The last modification timestamp of the entry in the source system.
hasModifyTime
clearModifyTime
setModifyTime
The last modification timestamp of the entry in the source system.
$this
getIntegratedSystem
Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
int
hasIntegratedSystem
setIntegratedSystem
Output only. The source system that Data Catalog automatically integrates with, such as BigQuery, Cloud Pub/Sub, or Dataproc Metastore.
var
int
$this
getUserSpecifiedSystem
Custom source system that you can manually integrate Data Catalog with.
string
hasUserSpecifiedSystem
setUserSpecifiedSystem
Custom source system that you can manually integrate Data Catalog with.
var
string
$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
string
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
var
string
$this
getDisplayName
The display name of the result.
string
setDisplayName
The display name of the result.
var
string
$this
getDescription
Entry description that can consist of several sentences or paragraphs that describe entry contents.
string
setDescription
Entry description that can consist of several sentences or paragraphs that describe entry contents.
var
string
$this
getSystem
string
