Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1335123147.4 KB
projects

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.

post/v1/{+parent}/entries

Path parameters

parentstring required

Required. The name of the entry group this entry belongs to. Note: The entry itself and its child resources might not be stored in the location specified in its name.

Query parameters

entryIdstring

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.

Request body

namestring

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.

linkedResourcestring

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.

fullyQualifiedNamestring

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'ENTRY_TYPE_UNSPECIFIED' | 'TABLE' | 'MODEL' | 'DATA_STREAM' | 'FILESET' | 'CLUSTER' | 'DATABASE' | 'DATA_SOURCE_CONNECTION' | 'ROUTINE' | 'LAKE' | 'ZONE' | 'SERVICE' | 'DATABASE_SCHEMA' | 'DASHBOARD' | 'EXPLORE' | 'LOOK' | 'FEATURE_ONLINE_STORE' | 'FEATURE_VIEW' | 'FEATURE_GROUP' | 'GRAPH'

The type of the entry. For details, see EntryType.

userSpecifiedTypestring

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.

integratedSystem'INTEGRATED_SYSTEM_UNSPECIFIED' | 'BIGQUERY' | 'CLOUD_PUBSUB' | 'DATAPROC_METASTORE' | 'DATAPLEX' | 'CLOUD_SPANNER' | 'CLOUD_BIGTABLE' | 'CLOUD_SQL' | 'LOOKER' | 'VERTEX_AI'

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

userSpecifiedSystemstring

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.

displayNamestring

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

descriptionstring

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.

labelsobject

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.

Response

Successful response