Google Cloud Data Catalog V1 Client - Class Entry (1.4.2)

Version 1.4.2

• 2.1.0 (latest)
• 2.0.2
• 1.10.3
• 1.9.1
• 1.8.2
• 1.7.1
• 1.6.0
• 1.5.1
• 1.4.2
• 1.3.9

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. 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 afterwards. Can be used for search and lookup of the entries. 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}
↳ type	int The type of the entry. Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_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	Google\Cloud\DataCatalog\V1\SqlDatabaseSystemSpec Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE
↳ looker_system_spec	Google\Cloud\DataCatalog\V1\LookerSystemSpec Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER
↳ gcs_fileset_spec	Google\Cloud\DataCatalog\V1\GcsFilesetSpec Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.
↳ bigquery_table_spec	Google\Cloud\DataCatalog\V1\BigQueryTableSpec Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.
↳ bigquery_date_sharded_spec	Google\Cloud\DataCatalog\V1\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	Google\Cloud\DataCatalog\V1\DatabaseTableSpec Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.
↳ data_source_connection_spec	Google\Cloud\DataCatalog\V1\DataSourceConnectionSpec Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.
↳ routine_spec	Google\Cloud\DataCatalog\V1\RoutineSpec Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.
↳ fileset_spec	Google\Cloud\DataCatalog\V1\FilesetSpec Specification that applies to a fileset resource. Valid only for entries with the FILESET type.
↳ 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	Google\Cloud\DataCatalog\V1\BusinessContext Business Context of the entry. Not supported for BigQuery datasets
↳ schema	Google\Cloud\DataCatalog\V1\Schema Schema of the entry. An entry might not have any schema attached to it.
↳ source_system_timestamps	Google\Cloud\DataCatalog\V1\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	Google\Cloud\DataCatalog\V1\UsageSignal Resource usage statistics.
↳ 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	Google\Cloud\DataCatalog\V1\DataSource Output only. Physical location of the entry.
↳ personal_details	Google\Cloud\DataCatalog\V1\PersonalDetails Output only. Additional information related to the entry. Private to the current user.

getName

Output only. 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.

Returns
Type	Description
string

setName

Output only. 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.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$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 afterwards. Can be used for search and lookup of the entries.

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}

Returns
Type	Description
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 afterwards. Can be used for search and lookup of the entries.

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}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getType

The type of the entry.

Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

Returns
Type	Description
int

hasType

setType

The type of the entry.

Only used for entries with types listed in the EntryType enum. Currently, only FILESET enum value is allowed. All other entries created in Data Catalog must use the user_specified_type.

Parameter
Name	Description
var	int

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getIntegratedSystem

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

Returns
Type	Description
int

hasIntegratedSystem

setIntegratedSystem

Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore.

Parameter
Name	Description
var	int

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getSqlDatabaseSystemSpec

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

Returns
Type	Description
Google\Cloud\DataCatalog\V1\SqlDatabaseSystemSpec|null

hasSqlDatabaseSystemSpec

setSqlDatabaseSystemSpec

Specification that applies to a relational database system. Only settable when user_specified_system is equal to SQL_DATABASE

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\SqlDatabaseSystemSpec

Returns
Type	Description
$this

getLookerSystemSpec

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

Returns
Type	Description
Google\Cloud\DataCatalog\V1\LookerSystemSpec|null

hasLookerSystemSpec

setLookerSystemSpec

Specification that applies to Looker sysstem. Only settable when user_specified_system is equal to LOOKER

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\LookerSystemSpec

Returns
Type	Description
$this

getGcsFilesetSpec

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\GcsFilesetSpec|null

hasGcsFilesetSpec

setGcsFilesetSpec

Specification that applies to a Cloud Storage fileset. Valid only for entries with the FILESET type.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\GcsFilesetSpec

Returns
Type	Description
$this

getBigqueryTableSpec

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\BigQueryTableSpec|null

hasBigqueryTableSpec

setBigqueryTableSpec

Output only. Specification that applies to a BigQuery table. Valid only for entries with the TABLE type.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\BigQueryTableSpec

Returns
Type	Description
$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.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\BigQueryDateShardedSpec|null

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.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\BigQueryDateShardedSpec

Returns
Type	Description
$this

getDatabaseTableSpec

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\DatabaseTableSpec|null

hasDatabaseTableSpec

setDatabaseTableSpec

Specification that applies to a table resource. Valid only for entries with the TABLE or EXPLORE type.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\DatabaseTableSpec

Returns
Type	Description
$this

getDataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\DataSourceConnectionSpec|null

hasDataSourceConnectionSpec

setDataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\DataSourceConnectionSpec

Returns
Type	Description
$this

getRoutineSpec

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\RoutineSpec|null

hasRoutineSpec

setRoutineSpec

Specification that applies to a user-defined function or procedure. Valid only for entries with the ROUTINE type.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\RoutineSpec

Returns
Type	Description
$this

getFilesetSpec

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\FilesetSpec|null

hasFilesetSpec

setFilesetSpec

Specification that applies to a fileset resource. Valid only for entries with the FILESET type.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\FilesetSpec

Returns
Type	Description
$this

getDisplayName

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

Returns
Type	Description
string

setDisplayName

Display name of an entry.

The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string.

Parameter
Name	Description
var	string

Returns
Type	Description
$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.

Returns
Type	Description
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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getBusinessContext

Business Context of the entry. Not supported for BigQuery datasets

Returns
Type	Description
Google\Cloud\DataCatalog\V1\BusinessContext|null

hasBusinessContext

clearBusinessContext

setBusinessContext

Business Context of the entry. Not supported for BigQuery datasets

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\BusinessContext

Returns
Type	Description
$this

getSchema

Schema of the entry. An entry might not have any schema attached to it.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\Schema|null

hasSchema

clearSchema

setSchema

Schema of the entry. An entry might not have any schema attached to it.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\Schema

Returns
Type	Description
$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.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\SystemTimestamps|null

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.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\SystemTimestamps

Returns
Type	Description
$this

getUsageSignal

Resource usage statistics.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\UsageSignal|null

hasUsageSignal

clearUsageSignal

setUsageSignal

Resource usage statistics.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\UsageSignal

Returns
Type	Description
$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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getDataSource

Output only. Physical location of the entry.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\DataSource|null

hasDataSource

clearDataSource

setDataSource

Output only. Physical location of the entry.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\DataSource

Returns
Type	Description
$this

getPersonalDetails

Output only. Additional information related to the entry. Private to the current user.

Returns
Type	Description
Google\Cloud\DataCatalog\V1\PersonalDetails|null

hasPersonalDetails

clearPersonalDetails

setPersonalDetails

Output only. Additional information related to the entry. Private to the current user.

Parameter
Name	Description
var	Google\Cloud\DataCatalog\V1\PersonalDetails

Returns
Type	Description
$this

getEntryType

Returns
Type	Description
string

getSystem

Returns
Type	Description
string

getSystemSpec

Returns
Type	Description
string

getTypeSpec

Returns
Type	Description
string

getSpec

Returns
Type	Description
string