Entry

class Entry : KotlinCustomResource

Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. An entry group can have a maximum of 100,000 entries. Auto-naming is currently not supported for this resource.

Properties

Link copied to clipboard

Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern. For more information, see Introduction to partitioned tables (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding).

Link copied to clipboard

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

Link copied to clipboard

Business Context of the entry. Not supported for BigQuery datasets

Link copied to clipboard

Specification that applies to Cloud Bigtable system. Only settable when integrated_system is equal to CLOUD_BIGTABLE

Link copied to clipboard

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

Link copied to clipboard

Physical location of the entry.

Link copied to clipboard

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

Link copied to clipboard
val description: Output<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.

Link copied to clipboard
val displayName: Output<String>

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

Link copied to clipboard
val entryGroupId: Output<String>
Link copied to clipboard
val entryId: Output<String>

Required. The ID of the entry to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores (_). The maximum size is 64 bytes when encoded in UTF-8.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

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

Link copied to clipboard
val labels: Output<Map<String, String>>

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.

Link copied to clipboard
val linkedResource: Output<String>

The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the Full Resource Name (https://cloud.google.com/apis/design/resource_names#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.

Link copied to clipboard
val location: Output<String>
Link copied to clipboard

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

Link copied to clipboard
val name: Output<String>

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.

Link copied to clipboard

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

Link copied to clipboard
val project: Output<String>
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Specification that applies to a Service resource.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val type: Output<String>

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.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

Resource usage statistics.

Link copied to clipboard

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.

Link copied to clipboard

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.