Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class Entry.
Entry metadata.
A Data Catalog entry represents another resource in Google
Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or
outside of it. You can use the linked_resource
field
in the entry resource to refer to the original resource ID of the source
system.
An entry resource contains resource details, for example, its schema.
Additionally, you can attach flexible metadata to an entry in the form of a Tag
.
Generated from protobuf message google.cloud.datacatalog.v1.Entry
Namespace
Google \ Cloud \ DataCatalog \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Identifier. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name.
↳ linked_resource
string
The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource
is the Full Resource Name
. For example, the linked_resource
for a table resource from BigQuery is: //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
Output only when the entry is one of the types in the EntryType
enum. For entries with a user_specified_type
, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8.
↳ fully_qualified_name
string
Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.
↳ type
↳ user_specified_type
string
Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType
enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type
. The user_specified_type
string has the following limitations: * * Is case insensitive. * * Must begin with a letter or underscore. * * Can only contain letters, numbers, and underscores. * * Must be at least 1 character and at most 64 characters long.
↳ integrated_system
int
Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
↳ user_specified_system
string
Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The user_specified_system
string has the following limitations: * * Is case insensitive. * * Must begin with a letter or underscore. * * Can only contain letters, numbers, and underscores. * * Must be at least 1 character and at most 64 characters long.
↳ sql_database_system_spec
SqlDatabaseSystemSpec
Specification that applies to a relational database system. Only settable when user_specified_system
is equal to SQL_DATABASE
↳ looker_system_spec
LookerSystemSpec
Specification that applies to Looker sysstem. Only settable when user_specified_system
is equal to LOOKER
↳ cloud_bigtable_system_spec
CloudBigtableSystemSpec
Specification that applies to Cloud Bigtable system. Only settable when integrated_system
is equal to CLOUD_BIGTABLE
↳ gcs_fileset_spec
GcsFilesetSpec
Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET
type.
↳ bigquery_table_spec
BigQueryTableSpec
Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE
type.
↳ bigquery_date_sharded_spec
BigQueryDateShardedSpec
Output only. Specification for a group of BigQuery tables with the [prefix]YYYYMMDD
name pattern. For more information, see Introduction to partitioned tables
.
↳ database_table_spec
DatabaseTableSpec
Specification that applies to a table resource. Valid only for entries with the TABLE
or EXPLORE
type.
↳ data_source_connection_spec
DataSourceConnectionSpec
Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION
type.
↳ routine_spec
RoutineSpec
Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE
type.
↳ dataset_spec
↳ fileset_spec
FilesetSpec
Specification that applies to a fileset resource. Valid only for entries with the FILESET
type.
↳ service_spec
↳ model_spec
↳ feature_online_store_spec
↳ display_name
string
Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
↳ description
string
Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
↳ business_context
↳ schema
↳ source_system_timestamps
SystemTimestamps
Timestamps from the underlying resource, not from the Data Catalog entry. Output only when the entry has a system listed in the IntegratedSystem
enum. For entries with user_specified_system
, this field is optional and defaults to an empty timestamp.
↳ usage_signal
↳ labels
array| Google\Protobuf\Internal\MapField
Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
↳ data_source
↳ personal_details
PersonalDetails
Output only. Additional information related to the entry. Private to the current user.
getName
Output only. Identifier. The resource name of an entry in URL format.
Note: The entry itself and its child resources might not be stored in the location specified in its name.
string
setName
Output only. Identifier. The resource name of an entry in URL format.
Note: The entry itself and its child resources might not be stored in the location specified in its name.
var
string
$this
getLinkedResource
The resource this metadata entry refers to.
For Google Cloud Platform resources, linked_resource
is the Full Resource Name
.
For example, the linked_resource
for a table resource from BigQuery is: //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
Output only when the entry is one of the types in the EntryType
enum.
For entries with a user_specified_type
, this field is optional and
defaults to an empty string.
The resource string must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), periods (.), colons (:), slashes (/), dashes (-),
and hashes (#).
The maximum size is 200 bytes when encoded in UTF-8.
string
setLinkedResource
The resource this metadata entry refers to.
For Google Cloud Platform resources, linked_resource
is the Full Resource Name
.
For example, the linked_resource
for a table resource from BigQuery is: //bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}
Output only when the entry is one of the types in the EntryType
enum.
For entries with a user_specified_type
, this field is optional and
defaults to an empty string.
The resource string must contain only letters (a-z, A-Z), numbers (0-9),
underscores (_), periods (.), colons (:), slashes (/), dashes (-),
and hashes (#).
The maximum size is 200 bytes when encoded in UTF-8.
var
string
$this
getFullyQualifiedName
Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.
string
setFullyQualifiedName
Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries.
var
string
$this
getType
The type of the entry.
For details, see EntryType
.
int
hasType
setType
The type of the entry.
For details, see EntryType
.
var
int
$this
getUserSpecifiedType
Custom entry type that doesn't match any of the values allowed for input
and listed in the EntryType
enum.
When creating an entry, first check the type values in the enum.
If there are no appropriate types for the new entry,
provide a custom value, for example, my_special_type
.
The user_specified_type
string has the following limitations:
- Is case insensitive.
- Must begin with a letter or underscore.
- Can only contain letters, numbers, and underscores.
- Must be at least 1 character and at most 64 characters long.
string
hasUserSpecifiedType
setUserSpecifiedType
Custom entry type that doesn't match any of the values allowed for input
and listed in the EntryType
enum.
When creating an entry, first check the type values in the enum.
If there are no appropriate types for the new entry,
provide a custom value, for example, my_special_type
.
The user_specified_type
string has the following limitations:
- Is case insensitive.
- Must begin with a letter or underscore.
- Can only contain letters, numbers, and underscores.
- Must be at least 1 character and at most 64 characters long.
var
string
$this
getIntegratedSystem
Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
int
hasIntegratedSystem
setIntegratedSystem
Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.
var
int
$this
getUserSpecifiedSystem
Indicates the entry's source system that Data Catalog doesn't automatically integrate with.
The user_specified_system
string has the following limitations:
- Is case insensitive.
- Must begin with a letter or underscore.
- Can only contain letters, numbers, and underscores.
- Must be at least 1 character and at most 64 characters long.
string
hasUserSpecifiedSystem
setUserSpecifiedSystem
Indicates the entry's source system that Data Catalog doesn't automatically integrate with.
The user_specified_system
string has the following limitations:
- Is case insensitive.
- Must begin with a letter or underscore.
- Can only contain letters, numbers, and underscores.
- Must be at least 1 character and at most 64 characters long.
var
string
$this
getSqlDatabaseSystemSpec
Specification that applies to a relational database system. Only settable
when user_specified_system
is equal to SQL_DATABASE
hasSqlDatabaseSystemSpec
setSqlDatabaseSystemSpec
Specification that applies to a relational database system. Only settable
when user_specified_system
is equal to SQL_DATABASE
$this
getLookerSystemSpec
Specification that applies to Looker sysstem. Only settable when user_specified_system
is equal to LOOKER
hasLookerSystemSpec
setLookerSystemSpec
Specification that applies to Looker sysstem. Only settable when user_specified_system
is equal to LOOKER
$this
getCloudBigtableSystemSpec
Specification that applies to Cloud Bigtable system. Only settable when integrated_system
is equal to CLOUD_BIGTABLE
hasCloudBigtableSystemSpec
setCloudBigtableSystemSpec
Specification that applies to Cloud Bigtable system. Only settable when integrated_system
is equal to CLOUD_BIGTABLE
$this
getGcsFilesetSpec
Specification that applies to a Cloud Storage fileset. Valid only
for entries with the FILESET
type.
hasGcsFilesetSpec
setGcsFilesetSpec
Specification that applies to a Cloud Storage fileset. Valid only
for entries with the FILESET
type.
$this
getBigqueryTableSpec
Output only. Specification that applies to a BigQuery table. Valid only
for entries with the TABLE
type.
hasBigqueryTableSpec
setBigqueryTableSpec
Output only. Specification that applies to a BigQuery table. Valid only
for entries with the TABLE
type.
$this
getBigqueryDateShardedSpec
Output only. Specification for a group of BigQuery tables with
the [prefix]YYYYMMDD
name pattern.
For more information, see Introduction to partitioned tables .
hasBigqueryDateShardedSpec
setBigqueryDateShardedSpec
Output only. Specification for a group of BigQuery tables with
the [prefix]YYYYMMDD
name pattern.
For more information, see Introduction to partitioned tables .
$this
getDatabaseTableSpec
Specification that applies to a table resource. Valid only
for entries with the TABLE
or EXPLORE
type.
hasDatabaseTableSpec
setDatabaseTableSpec
Specification that applies to a table resource. Valid only
for entries with the TABLE
or EXPLORE
type.
$this
getDataSourceConnectionSpec
Specification that applies to a data source connection. Valid only
for entries with the DATA_SOURCE_CONNECTION
type.
hasDataSourceConnectionSpec
setDataSourceConnectionSpec
Specification that applies to a data source connection. Valid only
for entries with the DATA_SOURCE_CONNECTION
type.
$this
getRoutineSpec
Specification that applies to a user-defined function or procedure. Valid
only for entries with the ROUTINE
type.
hasRoutineSpec
setRoutineSpec
Specification that applies to a user-defined function or procedure. Valid
only for entries with the ROUTINE
type.
$this
getDatasetSpec
Specification that applies to a dataset.
hasDatasetSpec
setDatasetSpec
Specification that applies to a dataset.
$this
getFilesetSpec
Specification that applies to a fileset resource. Valid only
for entries with the FILESET
type.
hasFilesetSpec
setFilesetSpec
Specification that applies to a fileset resource. Valid only
for entries with the FILESET
type.
$this
getServiceSpec
Specification that applies to a Service resource.
hasServiceSpec
setServiceSpec
Specification that applies to a Service resource.
$this
getModelSpec
Model specification.
hasModelSpec
setModelSpec
Model specification.
$this
getFeatureOnlineStoreSpec
FeatureonlineStore spec for Vertex AI Feature Store.
hasFeatureOnlineStoreSpec
setFeatureOnlineStoreSpec
FeatureonlineStore spec for Vertex AI Feature Store.
$this
getDisplayName
Display name of an entry.
The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
string
setDisplayName
Display name of an entry.
The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.
var
string
$this
getDescription
Entry description that can consist of several sentences or paragraphs that describe entry contents.
The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
string
setDescription
Entry description that can consist of several sentences or paragraphs that describe entry contents.
The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string.
var
string
$this
getBusinessContext
Business Context of the entry. Not supported for BigQuery datasets
hasBusinessContext
clearBusinessContext
setBusinessContext
Business Context of the entry. Not supported for BigQuery datasets
$this
getSchema
Schema of the entry. An entry might not have any schema attached to it.
hasSchema
clearSchema
setSchema
Schema of the entry. An entry might not have any schema attached to it.
$this
getSourceSystemTimestamps
Timestamps from the underlying resource, not from the Data Catalog entry.
Output only when the entry has a system listed in the IntegratedSystem
enum. For entries with user_specified_system
, this field is optional
and defaults to an empty timestamp.
hasSourceSystemTimestamps
clearSourceSystemTimestamps
setSourceSystemTimestamps
Timestamps from the underlying resource, not from the Data Catalog entry.
Output only when the entry has a system listed in the IntegratedSystem
enum. For entries with user_specified_system
, this field is optional
and defaults to an empty timestamp.
$this
getUsageSignal
Resource usage statistics.
hasUsageSignal
clearUsageSignal
setUsageSignal
Resource usage statistics.
$this
getLabels
Cloud labels attached to the entry.
In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
setLabels
Cloud labels attached to the entry.
In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system.
$this
getDataSource
Output only. Physical location of the entry.
hasDataSource
clearDataSource
setDataSource
Output only. Physical location of the entry.
$this
getPersonalDetails
Output only. Additional information related to the entry. Private to the current user.
hasPersonalDetails
clearPersonalDetails
setPersonalDetails
Output only. Additional information related to the entry. Private to the current user.
$this
getEntryType
string
getSystem
string
getSystemSpec
string
getTypeSpec
string
getSpec
string
